rujira 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da8ad0745459d377638ecda7132f7b24cebe44f73802cc5ac58e089ed8d93fda
-  data.tar.gz: 0e1d0d3ce944fc903b275981abf8238868579f52f5675648fb0bcff55d87ca03
+  metadata.gz: b6c5b714472d56b23db8bfe6a5a96e60c3dfd6af7cb8176fbef27d839bc2ace3
+  data.tar.gz: 106ca92334c64b3129f4e66d8aaa570eaa4d09adcba9ac7dad1d4136d6c251a8
 SHA512:
-  metadata.gz: 15262ee9a7f5a69116a033f3fbb6e72889db11694ca5c15f5dde5e734455afac197679eeab8a3ae3ecfc4aa3da97d230dea4507d337b5c577f2160d207e13c6a
-  data.tar.gz: 57bf1f91fdc28d4d77f237a0a8c2efa4ac085ca2e6493bf7a354abbc952106019119487a389d1b0b33ee4923b26e0858464f88631176095db627785b2ed5d19a
+  metadata.gz: ae579ef0d21f37fb22002669d668ddf6f876a1940da8fd0e5cd6022f8458407913ea3ba398af98590daf75b8dcd4b4b783c0764c05081aef60e24a4db789450d
+  data.tar.gz: 19062bf410f45b08e1a1554743a7f179acb314d3e95a8a92c5d914b1147b64458797ea849da34c19e3867e6c726add88f23c810f186df2cd6f81c76794a1bb39

data/README.md

@@ -8,32 +8,58 @@
 
     name = Rujira::Api::Myself.get.name
     Rujira::Api::Project.get 'ITMG'
-    Rujira::Api::Issue.create fields: {
-      project: { key: 'ITMG' },
-      summary: 'BOT: added a new feature.',
-      description: 'This task was generated by the bot when creating changes in the repository.',
-      issuetype: { name: 'Task' },
-      labels: ['bot']
-    }
+    Rujira::Api::Issue.create do
+        data fields: {
+             project: { key: 'ITMG' },
+             summary: 'BOT: added a new feature.',
+             description: 'This task was generated by the bot when creating changes in the repository.',
+             issuetype: { name: 'Task' },
+             labels: ['bot'] }
+        params updateHistory: true
+    end
     Rujira::Api::Issue.watchers 'ITMG-1', 'wilful'
     Rujira::Api::Issue.get 'ITMG-1'
-    Rujira::Api::Search.get jql: 'project = ITMG and status IN ("To Do", "In Progress") ORDER BY issuekey',
-      maxResults: 10,
-      startAt: 0,
-      fields: ['id', 'key']
-    Rujira::Api::Issue.comment 'ITMG-1', body: 'Adding a new comment'
-    Rujira::Api::Issue.edit 'ITMG-1', update: {
-      labels:[{add: 'rujira'},{remove: 'bot'}],
-    },
-      fields: {
-        assignee: { name: name },
-        summary: 'This is a shorthand for a set operation on the summary field'
-    }
+    result = Rujira::Api::Search.get do
+        data jql: 'project = ITMG and status IN ("To Do", "In Progress") ORDER BY issuekey',
+             maxResults: 10,
+             startAt: 0,
+             fields: ['id', 'key']
+    end
+    result.iter
+    Rujira::Api::Issue.comment 'ITMG-1' do
+        data body: 'Adding a new comment'
+    end
+    Rujira::Api::Issue.edit 'ITMG-1' do
+        data update: {
+             labels:[{add: 'rujira'},{remove: 'bot'}],
+            },
+            fields: {
+            assignee: { name: name },
+            summary: 'This is a shorthand for a set operation on the summary field'
+        }
+    end
+    Rujira::Api::Issue.attachments 'ITMG-1', 'upload.png'
     Rujira::Api::Issue.del 'ITMG-1'
 
+## Rake tasks
+
+    require 'rujira/tasks/jira'
+    rake jira::whoami
+    rake jira:create -- '--project=ITMG' \
+        '--summary=The short summary information' \
+        '--description=The base description of task' \
+        '--issuetype=Task'
+    rake jira:search -- '-q project = ITMG'
+
 ## Testing
 
 ### Run the instance of jira
 
     docker compose up -d
     open http://localhost:8080
+
+### Example with Curl
+
+    curl -H "Authorization: Bearer <JIRA_ACCESS_TOKEN>" 'http://localhost:8080/rest/api/2/search?expand=summary'
+    curl -D- -F "file=@upload.png" -X POST -H "X-Atlassian-Token: nocheck" \
+        -H "Authorization: Bearer <JIRA_ACCESS_TOKEN>" 'http://localhost:8080/rest/api/2/issue/ITMG-70/attachments'

data/Rakefile

@@ -1,4 +1,22 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-task default: %i[]
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
+require 'rujira'
+require 'rujira/tasks/jira'
+
+task default: %i[test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = false
+end
+
+Rujira::Tasks::Jira.new
+
+task :version do
+  puts Rujira::VERSION
+end

data/compose.yaml

@@ -5,6 +5,7 @@ services:
     restart: always
     image: atlassian/jira-software
     environment: {}
+      # JVM_SUPPORT_RECOMMENDED_ARGS: "-Datlassian.recovery.password=<PASSWORD>"
     ports:
       - 8080:8080
     volumes:

data/lib/rujira/api/attachments.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # TODO
+    # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/comment/%7BcommentId%7D/properties
+    class Attachments < Item; end
+  end
+end

data/lib/rujira/api/issue.rb

@@ -5,56 +5,70 @@ module Rujira
     # TODO
     # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/issue
     class Issue < Item
-      def self.get(id_or_key)
+      def self.create(&block)
         entity = Entity.build do
-          path "issue/#{id_or_key}"
+          path 'issue'
+          method :POST
+          instance_eval(&block) if block_given?
         end
         new(entity.commit)
       end
 
-      def self.del(id_or_key)
+      def self.get(id_or_key, &block)
         entity = Entity.build do
           path "issue/#{id_or_key}"
-          method :DELETE
+          instance_eval(&block) if block_given?
         end
-        entity.commit
+        new(entity.commit)
       end
 
-      def self.create(**data)
+      def self.del(id_or_key, &block)
         entity = Entity.build do
-          path 'issue'
-          method :POST
-          data data if data
+          path "issue/#{id_or_key}"
+          method :DELETE
+          instance_eval(&block) if block_given?
         end
-        new(entity.commit)
+        entity.commit
       end
 
-      def self.edit(id_or_key, **data)
+      def self.edit(id_or_key, &block)
         entity = Entity.build do
           path "issue/#{id_or_key}"
           method :PUT
-          data data
+          instance_eval(&block) if block_given?
         end
         new(entity.commit)
       end
 
-      def self.comment(id_or_key, **data)
+      def self.comment(id_or_key, &block)
         entity = Entity.build do
           path "issue/#{id_or_key}/comment"
           method :POST
-          data data if data
+          instance_eval(&block) if block_given?
         end
         Comment.new(entity.commit)
       end
 
-      def self.watchers(id_or_key, data)
+      def self.watchers(id_or_key, &block)
         entity = Entity.build do
           path "issue/#{id_or_key}/watchers"
           method :POST
-          data data
+          instance_eval(&block) if block_given?
         end
         new(entity.commit)
       end
+
+      def self.attachments(id_or_key, path, &block)
+        entity = Entity.build do
+          path "issue/#{id_or_key}/attachments"
+          method :POST
+          headers 'Content-Type': 'multipart/form-data', 'X-Atlassian-Token': 'nocheck',
+                  'Transfer-Encoding': 'chunked', 'Content-Length': File.size(path).to_s
+          data file: Faraday::Multipart::FilePart.new(path, 'multipart/form-data')
+          instance_eval(&block) if block_given?
+        end
+        Attachments.new(entity.commit)
+      end
     end
   end
 end

data/lib/rujira/api/project.rb

@@ -5,9 +5,10 @@ module Rujira
     # TODO
     # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/project
     class Project < Item
-      def self.get(id_or_key)
+      def self.get(id_or_key, &block)
         entity = Entity.build do
           path "project/#{id_or_key}"
+          instance_eval(&block) if block_given?
         end
         new(entity.commit)
       end

data/lib/rujira/api/search.rb

@@ -5,13 +5,17 @@ module Rujira
     # TODO
     # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/search
     class Search < Item
-      def self.get(**data)
+      def self.get(&block)
         entity = Entity.build do
           path 'search'
-          data data
           method :POST
+          instance_eval(&block) if block_given?
         end
-        entity.commit['issues'].map do |issue|
+        new(entity.commit)
+      end
+
+      def iter
+        data['issues'].map do |issue|
           Issue.new(issue)
         end
       end

data/lib/rujira/api/server_info.rb

@@ -3,7 +3,7 @@
 module Rujira
   module Api
     # TODO
-    # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/myself
+    # https://docs.atlassian.com/software/jira/docs/api/REST/8.17.1/#api/2/serverInfo
     class ServerInfo < Item
       def self.get
         entity = Entity.build do

data/lib/rujira/connection.rb

@@ -13,6 +13,7 @@ module Rujira
     def run
       Faraday.new(@options) do |builder|
         builder.request :authorization, 'Bearer', -> { @token }
+        builder.request :multipart, flat_encode: true
         builder.request :json
         builder.response :json
         builder.response :raise_error

data/lib/rujira/entity.rb

@@ -5,6 +5,8 @@ module Rujira
   class Entity
     def initialize
       @method = :GET
+      @params = {}
+      @headers = {}
       @rest_api = 'rest/api/2'
     end
 
@@ -17,6 +19,14 @@ module Rujira
       entity
     end
 
+    def params(params)
+      @params = params
+    end
+
+    def headers(headers)
+      @headers = headers
+    end
+
     def method(method)
       @method = method
     end
@@ -60,20 +70,26 @@ module Rujira
 
     def get
       request do
-        client.get path
+        client.get path do |req|
+          req.params = @params
+        end
       end
     end
 
     def delete
       request do
-        client.delete path
+        client.delete path do |req|
+          req.params = @params
+        end
       end
     end
 
     def post
       request do
         client.post path do |req|
-          req.body = data.to_json
+          req.headers = @headers
+          req.params = @params
+          req.body = data
         end
       end
     end
@@ -81,7 +97,8 @@ module Rujira
     def put
       request do
         client.put path do |req|
-          req.body = data.to_json
+          req.params = @params
+          req.body = data
         end
       end
     end

data/lib/rujira/tasks/jira.rb

@@ -11,47 +11,86 @@ module Rujira
       include ::Rake::DSL if defined?(::Rake::DSL)
 
       def initialize
+        @options = {
+          issuetype: 'Task'
+        }
+        @parser = OptionParser.new
         define
       end
 
-      def define
-        whoami
-        url
-        server_info
+      def parser
+        yield
+        args = @parser.order!(ARGV) {}
+        @parser.parse!(args)
       end
 
-      def whoami
-        name = __method__
-        desc 'Request my real name in Jira'
+      def options(name)
+        @options[name]
+      end
 
-        Rake::Task[name].clear if Rake::Task.task_defined?(name)
-        namespace :jira do
-          task name do
-            puts Rujira::Api::Myself.get.name
-          end
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/MethodLength
+      def define
+        generate 'whoami' do
+          puts Rujira::Api::Myself.get.name
         end
-      end
+        generate 'url' do
+          puts Rujira::Configuration.url
+        end
+        generate 'server_info' do
+          puts Rujira::Api::ServerInfo.get.data.to_json
+        end
+        generate 'create' do
+          parser do
+            @parser.banner = "Usage: rake jira:task:create -- '[options]'"
+            @parser.on('-p PROJECT', '--project=PROJECT') { |project| @options[:project] = project.strip }
+            @parser.on('-s SUMMARY', '--summary=SUMMARY') { |summary| @options[:summary] = summary.strip }
+            @parser.on('-d DESCRIPTION', '--description=DESCRIPTION') do |description|
+              @options[:description] = description.strip
+            end
+            @parser.on('-i ISSUETYPE', '--issuetype=ISSUETYPE') { |issuetype| @options[:issuetype] = issuetype.strip }
+          end
 
-      def url
-        name = __method__
-        desc 'Request server url from Jira'
+          result = Rujira::Api::Issue.create fields: {
+            project: { key: @options[:project] },
+            summary: @options[:summary],
+            issuetype: { name: @options[:issuetype] },
+            description: @options[:description]
+          }
+          url = Rujira::Configuration.url
+          puts "// A new task been posted, check it out at #{url}/browse/#{result.data['key']}"
+        end
+        generate 'search' do
+          parser do
+            @parser.banner = "Usage: rake jira:task:search -- '[options]'"
+            @parser.on('-q JQL', '--jql=JQL') { |jql| @options[:jql] = jql }
+          end
 
-        Rake::Task[name].clear if Rake::Task.task_defined?(name)
-        namespace :jira do
-          task name do
-            puts Rujira::Configuration.url
+          result = Rujira::Api::Search.get jql: @options[:jql]
+          result.iter.each { |i| puts JSON.pretty_generate(i.data) }
+        end
+        generate 'attach' do
+          parser do
+            @parser.banner = "Usage: rake jira:task:attach -- '[options]'"
+            @parser.on('-f FILE', '--file=FILE') { |jql| @options[:file] = jql }
+            @parser.on('-i ID', '--issue=ID') { |jql| @options[:id] = jql }
           end
+
+          result = Rujira::Api::Issue.attachments @options[:id], @options[:file]
+          JSON.pretty_generate(result)
         end
       end
+      # rubocop:enable Metrics/AbcSize
+      # rubocop:enable Metrics/MethodLength
 
-      def server_info
-        name = __method__
-        desc 'Request server information from Jira'
+      def generate(name, &block)
+        fullname = "jira:#{name}"
+        desc "Run #{fullname}"
 
-        Rake::Task[name].clear if Rake::Task.task_defined?(name)
+        Rake::Task[fullname].clear if Rake::Task.task_defined?(fullname)
         namespace :jira do
           task name do
-            puts Rujira::Api::ServerInfo.get.data.to_json
+            instance_eval(&block)
           end
         end
       end

data/lib/rujira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rujira
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

data/lib/rujira.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday/multipart'
 require 'json'
 require_relative 'rujira/version'
 require_relative 'rujira/connection'
@@ -11,6 +12,7 @@ require_relative 'rujira/api/search'
 require_relative 'rujira/api/issue'
 require_relative 'rujira/api/project'
 require_relative 'rujira/api/comment'
+require_relative 'rujira/api/attachments'
 require_relative 'rujira/api/myself'
 require_relative 'rujira/api/server_info'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rujira
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Andrey Semenov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-05-03 00:00:00.000000000 Z
 dependencies: []
 description: The library is developed for the purposes of the organization, new features
   can be added as MR. Welcome!
@@ -25,6 +25,7 @@ files:
 - Rakefile
 - compose.yaml
 - lib/rujira.rb
+- lib/rujira/api/attachments.rb
 - lib/rujira/api/comment.rb
 - lib/rujira/api/issue.rb
 - lib/rujira/api/item.rb