rujira 0.1.14 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77641c9b95c2b8777a5e95202deb2bf38ab8d41e1d2e339f95ab5f2c1243bce8
-  data.tar.gz: 759fb9ee8e937322f10c266fb88ea71abe7f8f59a66396e18092ef378bcc37af
+  metadata.gz: '099900e906a1d71b9c787fa6565fa02bdce269dba4ab74394f6c222b10f3a737'
+  data.tar.gz: f00ae30d02ca63aecca57b1ea8099fa0afe2482de3baa385f92e7d29968ae83d
 SHA512:
-  metadata.gz: 901f27c13e274d717e52dda2218b9bf70c3432a7a2077f0e70f3203673c4218280e875efb96d50220e4d7e2e07ac81cf2fee2645f3210cc0ed54a911d935fe99
-  data.tar.gz: 9cee06af219613b52e24337ad2441a2f10b880e351d2d60075a2aef5b14fd2460813541086047c94db6381588764b6cd7a6a10676c35d48000d85bd9443ea163
+  metadata.gz: 581f6a09da83eadd7ef5d474face9d61e34b91999c3009094c7be6a83872eb18a0c2a50fc1462b910b36b289b8e1277906744f738aae6c7f179a6cc0a3193e01
+  data.tar.gz: 82d46f9a3a7d56a605d69cb5263c5b3be64fda4973920766de48cbe5b12a7e8b22d96b740497faa3edccbc4848a3d910ee1f66b897bcfd95927993b68ec45d5c

data/CHANGELOG.md

@@ -1,5 +1,83 @@
-## [Unreleased]
+## [0.3.1] - 2025-09-13
 
-## [0.1.0] - 2024-04-10
+### 🚜 Refactor
 
-- Initial release
+- Fix for headers setter
+- 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
+## [0.2.0] - 2025-09-11
+
+### 🚀 Features
+
+- Added new method for API
+
+### 📚 Documentation
+
+- Update README
+## [0.1.15] - 2025-09-11
+
+### 🚀 Features
+
+- Added dotenv
+- Update a gems
+- Example of generation url
+
+### 🐛 Bug Fixes
+
+- No test in CI
+
+### 🚜 Refactor
+
+- Docs
+- BUILDER
+- RAKE TASKS
+
+### 📚 Documentation
+
+- Fix a readme
+
+### Hotfix
+
+- Remove debug line
+
+### ITMG
+
+- Work with missing methods
+- Rewrite tasks for gem
+- Added project create entrypoint
+
+### Reafactor
+
+- Full
+## [0.1.10] - 2024-07-05
+
+### ITMG
+
+- Adding watchers and security level getter
+## [0.1.9] - 2024-06-23
+
+### ITMG
+
+- Description fixes
+- Release 0.1.8

data/README.md

@@ -1,78 +1,201 @@
-# Rujira
-
-## Running
-
-    RUJIRA_DEBUG=true RUJIRA_URL=http://localhost:8080 RUJIRA_TOKEN=<JIRA_ACCESS_TOKEN> bundle exec ./bin/console
-
-## Usage in the code
-
-    project = random_name
-    name = Rujira::Api::Myself.get.name
-    Rujira::Api::Project.create do
-      data key: project.to_s,
-           name: project.to_s,
-           projectTypeKey: 'software',
-           lead: 'root'
-    end
-    Rujira::Api::Project.get project.to_s
-    Rujira::Api::Issue.create do
-      data fields: {
-        project: { key: project.to_s },
-        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
-    Rujira::Api::Issue.watchers "#{project}-1", name
-    Rujira::Api::Issue.get "#{project}-1"
-    result = Rujira::Api::Search.get do
-      data jql: "project = #{project} and status IN (\"To Do\", \"In Progress\") ORDER BY issuekey",
-           maxResults: 10,
-           startAt: 0,
-           fields: %w[id key]
-    end
-    Rujira::Api::Issue.comment "#{project}-1" do
-      data body: 'Adding a new comment'
-    end
-    Rujira::Api::Issue.edit "#{project}-1" do
-      data update: {
-             labels: [{ add: 'bot' }, { remove: 'some' }]
-           },
-           fields: {
-             assignee: { name: name },
-             summary: 'This is a shorthand for a set operation on the summary field'
-           }
-    end
-    result.iter.each do |issue|
-      Rujira::Api::Issue.del issue.data['id'] do
-        params deleteSubtasks: true
-      end
-    end
-
-## Rake tasks
-
-    require 'rujira/tasks/jira'
-    Rujira::Tasks::Jira.new
-
-    rake jira:issue:whoami
-    rake jira:issue:create -- '--project=ITMG' \
-        '--summary=The short summary information' \
-        '--description=The base description of task' \
-        '--issuetype=Task'
-    rake jira:issue:search -- '-q project = ITMG'
-    rake jira:issue:attach -- '--file=upload.png' '--issue=ITMG-1'
-
-## 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 -vv -X POST --data '"some"' -H "Authorization: Bearer <JIRA_ACCESS_TOKEN>" -H "Content-Type: application/json" 'http://localhost:8080/rest/api/2/issue/ITMG-70/watchers'
-    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'
+# RUJIRA
+
+**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.
+
+---
+
+## Features
+
+* Easy DSL for building and executing Jira API requests.
+* Built-in Rake tasks for console operations (e.g., creating issues, updating data, exporting).
+
+---
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'rujira', '~> 0.1.0'
+```
+
+Or install directly:
+
+```bash
+gem install rujira
+```
+
+---
+
+## Quick Start
+
+### Configuration
+
+```ruby
+❯ cat .env
+RUJIRA_DEBUG=false
+RUJIRA_TOKEN='<TOKEN>'
+RUJIRA_URL='http://localhost:8080'
+```
+
+### Example of usage
+
+```ruby
+require 'date'
+
+now = Date.today
+before = now + 30
+
+project = random_name
+url = ENV.fetch('RUJIRA_URL', 'http://localhost:8080')
+client = Rujira::Client.new(url, debug: true)
+
+client.ServerInfo.get
+name = client.Myself.get['name']
+
+client.Project.create do
+  payload key: project.to_s,
+          name: project.to_s,
+          projectTypeKey: 'software',
+          lead: name
+end
+client.Project.get project.to_s
+client.Issue.create do
+  payload fields: {
+    project: { key: project.to_s },
+    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
+
+client.Board.list
+client.Board.get 1
+
+sprint = client.Sprint.create do
+  payload name: 'Bot Sprint',
+          originBoardId: 1,
+          goal: 'Finish core features for release 1.0',
+          autoStartStop: false
+end
+client.Sprint.issue sprint['id'], ["#{project}-1"]
+
+client.Sprint.replace sprint['id'] do
+  payload state: 'future',
+          name: 'Bot Sprint',
+          originBoardId: 1,
+          goal: 'Finish core features for release 1.0',
+          startDate: now,
+          endDate: before,
+          autoStartStop: true
+end
+
+update = client.Sprint.update sprint['id'] do
+  payload name: "Bot Sprint #{project}"
+end
+
+assert_equal 'Bot Sprint', sprint['name']
+assert_equal "Bot Sprint #{project}", update['name']
+
+issues = client.Sprint.get_issue sprint['id']
+
+assert_not_empty issues['issues']
+
+client.Issue.get "#{project}-1"
+
+client.Issue.watchers "#{project}-1", name
+search = client.Search.get do
+  payload jql: "project = #{project} and status IN (\"To Do\", \"In Progress\") ORDER BY issuekey",
+          maxResults: 10,
+          startAt: 0,
+          fields: %w[id key]
+end
+client.Issue.comment "#{project}-1" do
+  payload body: 'Adding a new comment'
+end
+client.Issue.edit "#{project}-1" do
+  payload update: {
+            labels: [{ add: 'bot' }, { remove: 'some' }]
+          },
+          fields: {
+            assignee: { name: name },
+            summary: 'This is a shorthand for a set operation on the summary field'
+          }
+end
+
+sprints = client.Board.sprint 1
+sprints['values'].each do |sprint|
+  client.Sprint.delete sprint['id']
+end
+search['issues'].each do |issue|
+  client.Issue.delete issue['id'] do
+    params deleteSubtasks: true
+  end
+end
+client.Project.delete project.to_s
+
+client.Dashboard.list
+client.Dashboard.get 10_000
+```
+
+* The `builder` method automatically applies the authorization token.
+* The block allows customization of headers, parameters, and other request options.
+
+---
+
+## Rake Tasks
+
+The gem includes Rake tasks for easy use from the command line. Examples:
+
+```bash
+rake jira:board:get               # Get a board
+rake jira:board:list              # Get list of boards
+rake jira:board:sprint            # Get a boards sprint
+rake jira:dashboard:get           # Get a dashboard
+rake jira:dashboard:list          # Get list of dashboards
+rake jira:issue:attach            # Example usage attaching in issue
+rake jira:issue:create            # Create a issue
+rake jira:issue:delete            # Delete issue
+rake jira:issue:search            # Search issue by fields
+rake jira:project:list            # Get list of projects
+rake jira:server_info             # Test connection by getting server information
+rake jira:sprint:properties:list  # Get sprint properties
+rake jira:whoami                  # Test connection by getting username
+```
+
+```bash
+rake jira:issue:create PROJECT=ITMG SUMMARY='The short summary information' \
+      DESCRIPTION='The base description of task' ISSUETYPE='Task'
+rake jira:issue:search JQL='project = ITMG'
+rake jira:issue:attach FILE='upload.png' ISSUE_ID='ITMG-1'
+```
+
+## Development runs
+
+```bash
+docker compose up -d
+open http://localhost:8080
+
+```
+
+```bash
+curl -H "Authorization: Bearer <JIRA_ACCESS_TOKEN>" 'http://localhost:8080/rest/api/2/search?expand=summary'
+curl -vv -X POST --data '"some"' -H "Authorization: Bearer <JIRA_ACCESS_TOKEN>" -H "Content-Type: application/json" 'http://localhost:8080/rest/api/2/issue/ITMG-70/watchers'
+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'
+
+```
+
+---
+
+## Contribution
+
+* Pull requests are welcome.
+* For issues or feature requests, please use GitHub Issues.
+
+---
+
+## License
+
+MIT License © 2025 iTmageLAB

data/Rakefile

@@ -3,11 +3,14 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'dotenv'
-Dotenv.load
 
 $LOAD_PATH.unshift File.expand_path('lib', __dir__)
-require 'rujira'
-require 'rujira/tasks/jira'
+
+require_relative 'lib/rujira'
+
+Rujira::Tasks::Jira.new
+
+Dotenv.load
 
 task default: %i[test]
 
@@ -17,8 +20,6 @@ Rake::TestTask.new do |t|
   t.verbose = false
 end
 
-Rujira::Tasks::Jira.new
-
 task :version do
   puts Rujira::VERSION
 end

data/cliff.toml

@@ -0,0 +1,94 @@
+# git-cliff ~ configuration file
+# https://git-cliff.org/docs/configuration
+
+
+[changelog]
+# A Tera template to be rendered for each release in the changelog.
+# See https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}
+"""
+# Remove leading and trailing whitespaces from the changelog's body.
+trim = true
+# Render body even when there are no releases to process.
+render_always = true
+# An array of regex based postprocessors to modify the changelog.
+postprocessors = [
+  # Replace the placeholder <REPO> with a URL.
+  #{ pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" },
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[git]
+# Parse commits according to the conventional commits specification.
+# See https://www.conventionalcommits.org
+conventional_commits = true
+# Exclude commits that do not match the conventional commits specification.
+filter_unconventional = true
+# Require all commits to be conventional.
+# Takes precedence over filter_unconventional.
+require_conventional = false
+# Split commits on newlines, treating each line as an individual commit.
+split_commits = false
+# An array of regex based parsers to modify commit messages prior to further processing.
+commit_preprocessors = [
+  # Replace issue numbers with link templates to be updated in `changelog.postprocessors`.
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit message using https://github.com/crate-ci/typos.
+  # If the spelling is incorrect, it will be fixed automatically.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# Prevent commits that are breaking from being excluded by commit parsers.
+protect_breaking_commits = false
+# An array of regex based parsers for extracting data from the commit message.
+# Assigns commits to groups.
+# Optionally sets the commit's scope and can decide to exclude commits from further processing.
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# Exclude commits that are not matched by any commit parser.
+filter_commits = false
+# An array of link parsers for extracting external references, and turning them into URLs, using regex.
+link_parsers = []
+# Include only the tags that belong to the current branch.
+use_branch_tags = false
+# Order releases topologically instead of chronologically.
+topo_order = false
+# Order releases topologically instead of chronologically.
+topo_order_commits = true
+# Order of commits in each group/release within the changelog.
+# Allowed values: newest, oldest
+sort_commits = "newest"
+# Process submodules commits
+recurse_submodules = false
+
+limit_commits = 50

data/compose.yaml

@@ -2,6 +2,7 @@
 services:
   jira:
     restart: always
+    # mem_limit: 1g
     image: atlassian/jira-software
     environment: {}
       # JVM_SUPPORT_RECOMMENDED_ARGS: "-Datlassian.recovery.password=<PASSWORD>"
@@ -12,6 +13,7 @@ services:
 
   db:
     image: postgres
+    mem_limit: 128mb  
     restart: always
     shm_size: 128mb
     environment:

data/examples/create_issue_in_sprint.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'dotenv'
+require_relative '../lib/rujira'
+
+Dotenv.load
+
+client = Rujira::Client.new('http://localhost:8080')
+
+project_name = 'EXAMPLE2'
+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 }
+end
+
+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
+
+now = Date.today
+before = now + 30
+
+sprint = client.Sprint.create do
+  payload name: 'Bot Example Sprint',
+          originBoardId: 1,
+          goal: 'Finish core features for release 1.0',
+          startDate: now,
+          endDate: before,
+          autoStartStop: true
+end
+
+client.Sprint.update sprint['id'] do
+  payload state: 'active'
+end
+
+client.Sprint.issue sprint['id'], ["#{project_name}-1"]

data/lib/rujira/api/attachments.rb

@@ -3,7 +3,20 @@
 module Rujira
   module Api
     # TODO
-    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/comment/%7BcommentId%7D/properties
-    class Attachments < Common; end
+    # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/issue/%7BissueIdOrKey%7D/attachments
+    class Attachments < Common
+      def create(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
+    end
   end
 end

data/lib/rujira/api/board.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Rujira
+  module Api
+    # TODO
+    # https://docs.atlassian.com/jira-software/REST/9.17.0/#agile/1.0/board
+    class Board < Common
+      def initialize(client)
+        super
+        builder do
+          rest_base 'rest/agile/1.0'
+        end
+      end
+
+      def get(id)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}"
+        end
+        run
+      end
+
+      def list
+        builder do
+          path 'board'
+        end
+        run
+      end
+
+      def sprint(id)
+        abort 'Board ID is required' if id.to_s.strip.empty?
+        builder do
+          path "board/#{id}/sprint"
+        end
+        run
+      end
+    end
+  end
+end

data/lib/rujira/api/comment.rb

@@ -4,6 +4,16 @@ module Rujira
   module Api
     # TODO
     # https://docs.atlassian.com/software/jira/docs/api/REST/9.17.0/#api/2/comment/%7BcommentId%7D/properties
-    class Comment < Common; end
+    class Comment < Common
+      def create(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
+        run
+      end
+    end
   end
 end