gitlab-burndown 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e4d84f160a4747733a96bfb9bb2a6e1f0f23f60e4846106727af58c30d3e459
+  data.tar.gz: 70ac3b5102113d95cf768e026edc7c90ff92df64e104f55053cac78eea8a2141
+SHA512:
+  metadata.gz: d8bc99707477f54b09a309945ed2ee4e7acd9a642c16043d55c5838bb6fe35e314eac410072e343c2b025423767e5758fe82d780f26d1a6c8bdb2acfa3b31506
+  data.tar.gz: '094f88b960120723f902db6fcc1b6c4e3ef656e9f1b0312818ae34cef533e0eb005ac7e9a09cc69a2d2e9b15a08b2262e8e181dbcd89be61ba2ca2c051b29c68'

data/bin/gitlab-burndown

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'date'
+
+require 'gitlab-burndown/config/env_file_configuration'
+require 'gitlab-burndown/fetcher/group_issues'
+require 'gitlab-burndown/filter/filter_list'
+require 'gitlab-burndown/filter/closed_after_date'
+require 'gitlab-burndown/filter/no_include_labels'
+require 'gitlab-burndown/generator/burndown_csv_generator'
+require 'gitlab-burndown/generator/issue_csv_generator'
+require 'gitlab-burndown/gitlab/client'
+require 'gitlab-burndown/writer/file'
+
+if ARGV.length < 1
+  warn 'usage: gitlab-burndown <env_file>'
+  exit
+end
+
+environment_variables = %w[GL_TOKEN GL_HOST GL_API_VERSION GL_GROUP_ID INCLUDE_FROM_DATE EXCLUDE_LABELS OUTPUT_FILE]
+config = EnvFileConfiguration.new(ARGV[0], environment_variables)
+include_from_date = DateTime.iso8601(config.get('INCLUDE_FROM_DATE'))
+labels_to_exclude = config.get('EXCLUDE_LABELS').split ','
+
+client = GitlabHTTPClient.new(config)
+issue_filter = FilterList.new(ClosedAfterDateFilter.new(include_from_date),
+                              NoIncludeLabelsFilter.new(*labels_to_exclude))
+issue_fetcher = GroupIssueFetcher.new(client, issue_filter, config.get('GL_GROUP_ID'))
+csv_file_writer = FileWriter.new(config.get('OUTPUT_FILE'))
+burndown_csv_generator = BurndownCSVGenerator.new(issue_fetcher, IssueCSVGenerator, csv_file_writer)
+burndown_csv_generator.generate

data/lib/gitlab-burndown/config/configuration.rb

@@ -0,0 +1,25 @@
+require 'gitlab-burndown/error/not_implemented'
+require 'gitlab-burndown/error/no_such_variable'
+
+class Configuration
+  def initialize(required_keys)
+    @required_keys = required_keys
+    @config = Hash.new
+    load!
+    ensure_required_keys_exist
+  end
+
+  def get(variable_name)
+    @config[variable_name]
+  end
+
+  def load!
+    raise NotImplementedError
+  end
+
+  def ensure_required_keys_exist
+    @required_keys.each do |required_key|
+      raise NoSuchVariableError, required_key unless @config.key? required_key
+    end
+  end
+end

data/lib/gitlab-burndown/config/env_file_configuration.rb

@@ -0,0 +1,15 @@
+require 'gitlab-burndown/config/configuration'
+
+class EnvFileConfiguration < Configuration
+  def initialize(filename, required_keys)
+    @filename = filename
+    super(required_keys)
+  end
+
+  def load!
+    File.foreach(@filename) do |line|
+      key_value_pair = line.split('=', 2)
+      @config[key_value_pair[0]] = key_value_pair[1].strip!
+    end
+  end
+end

data/lib/gitlab-burndown/csv_field/category.rb

@@ -0,0 +1,14 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueCategoryCSVField < CSVField
+  def initialize(data_container)
+    super(data_container)
+  end
+
+  def format
+    category_label = @data_container['labels'].find { |label| label.include? 'Category::' }
+    return 'Uncategorized' if category_label.nil?
+
+    category_label.gsub('Category::', '')
+  end
+end

data/lib/gitlab-burndown/csv_field/closed_at.rb

@@ -0,0 +1,11 @@
+require 'date'
+
+require 'gitlab-burndown/csv_field/field'
+
+class IssueClosedAtCSVField < CSVField
+  def format
+    return '' if @data_container['closed_at'].nil?
+
+    Date.iso8601(@data_container['closed_at']).strftime('%d-%m-%Y')
+  end
+end

data/lib/gitlab-burndown/csv_field/closed_state.rb

@@ -0,0 +1,9 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueClosedStateCSVField < CSVField
+  def format
+    return '' if @data_container['closed_at'].nil?
+
+    'X'
+  end
+end

data/lib/gitlab-burndown/csv_field/field.rb

@@ -0,0 +1,11 @@
+require 'gitlab-burndown/error/not_implemented'
+
+class CSVField
+  def initialize(data_container)
+    @data_container = data_container
+  end
+
+  def format
+    raise NotImplementedError
+  end
+end

data/lib/gitlab-burndown/csv_field/fields.rb

@@ -0,0 +1,15 @@
+require 'gitlab-burndown/csv_field/field'
+
+class CSVFields < CSVField
+  def initialize(data_container, *csv_field_constructors)
+    super(data_container)
+    @csv_field_constructors = csv_field_constructors
+  end
+
+  def format
+    formatted_fields = @csv_field_constructors.map do |constructor|
+      constructor.new(@data_container).format
+    end
+    "#{formatted_fields.join(';')}\n"
+  end
+end

data/lib/gitlab-burndown/csv_field/hour_estimate.rb

@@ -0,0 +1,9 @@
+require 'gitlab-burndown/csv_field/field'
+
+SECONDS_IN_HOUR = 3600
+
+class IssueHourEstimateCSVField < CSVField
+  def format
+    @data_container['time_stats']['time_estimate'] / SECONDS_IN_HOUR
+  end
+end

data/lib/gitlab-burndown/csv_field/iid.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueIIDCSVField < CSVField
+  def format
+    @data_container['iid']
+  end
+end

data/lib/gitlab-burndown/csv_field/in_sprint.rb

@@ -0,0 +1,10 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueInSprintCSVField < CSVField
+  def format
+    if @data_container['labels'].include? "In Sprint"
+      return "X"
+    end
+    return ""
+  end
+end

data/lib/gitlab-burndown/csv_field/milestone.rb

@@ -0,0 +1,9 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueMilestoneCSVField < CSVField
+  def format
+    return '' if @data_container['milestone'].nil?
+
+    @data_container['milestone']['title']
+  end
+end

data/lib/gitlab-burndown/csv_field/title.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueTitleCSVField < CSVField
+  def format
+    @data_container['title']
+  end
+end

data/lib/gitlab-burndown/csv_field/web_url.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/csv_field/field'
+
+class IssueWebURLCSVField < CSVField
+  def format
+    @data_container['web_url']
+  end
+end

data/lib/gitlab-burndown/error/illegal_access.rb

@@ -0,0 +1,2 @@
+class IllegalAccessError < StandardError
+end

data/lib/gitlab-burndown/error/no_such_variable.rb

@@ -0,0 +1,2 @@
+class NoSuchVariableError < StandardError
+end

data/lib/gitlab-burndown/error/not_implemented.rb

@@ -0,0 +1,2 @@
+class NotImplementedError
+end

data/lib/gitlab-burndown/fetcher/fetcher.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/error/not_implemented'
+
+class Fetcher
+  def fetch
+    raise NotImplementedError
+  end
+end

data/lib/gitlab-burndown/fetcher/group_issues.rb

@@ -0,0 +1,16 @@
+require 'gitlab-burndown/fetcher/fetcher'
+
+class GroupIssueFetcher < Fetcher
+  def initialize(gitlab_client, issue_filter, group_id)
+    super()
+    @gitlab_client = gitlab_client
+    @issue_filter = issue_filter
+    @group_id = group_id
+  end
+
+  def fetch
+    @gitlab_client.get_group_issues(@group_id).select do |issue|
+      @issue_filter.apply issue
+    end
+  end
+end

data/lib/gitlab-burndown/filter/closed_after_date.rb

@@ -0,0 +1,16 @@
+require 'date'
+require 'gitlab-burndown/filter/filter'
+
+class ClosedAfterDateFilter < Filter
+  def initialize(last_allowed_date)
+    super()
+    @last_allowed_date = last_allowed_date
+  end
+
+  def apply(target)
+    return true if @last_allowed_date.nil?
+    return true if target['closed_at'].nil?
+
+    Date.iso8601(target['closed_at']) > @last_allowed_date
+  end
+end

data/lib/gitlab-burndown/filter/filter.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/error/not_implemented'
+
+class Filter
+  def apply(target)
+    raise NotImplementedError
+  end
+end

data/lib/gitlab-burndown/filter/filter_list.rb

@@ -0,0 +1,15 @@
+require 'gitlab-burndown/filter/filter'
+
+class FilterList < Filter
+  def initialize(*filters)
+    super()
+    @filters = filters
+  end
+
+  def apply(target)
+    @filters.each do |filter|
+      return false unless filter.apply target
+    end
+    true
+  end
+end

data/lib/gitlab-burndown/filter/no_include_labels.rb

@@ -0,0 +1,14 @@
+require 'gitlab-burndown/filter/filter'
+
+class NoIncludeLabelsFilter < Filter
+  def initialize(*labels)
+    super()
+    @labels = labels
+  end
+
+  def apply(target)
+    should_include = target['labels'].intersection(@labels).empty?
+    warn "Excluding '#{target['title']}' due to label filter" unless should_include
+    should_include
+  end
+end

data/lib/gitlab-burndown/generator/burndown_csv_generator.rb

@@ -0,0 +1,16 @@
+require 'gitlab-burndown/generator/generator'
+
+class BurndownCSVGenerator < Generator
+  def initialize(fetcher, csv_generator_constructor, writer)
+    super()
+    @fetcher = fetcher
+    @csv_generator_constructor = csv_generator_constructor
+    @writer = writer
+  end
+
+  def generate
+    issues = @fetcher.fetch
+    csv = @csv_generator_constructor.new(issues).generate
+    @writer.write csv
+  end
+end

data/lib/gitlab-burndown/generator/csv_generator.rb

@@ -0,0 +1,21 @@
+require 'gitlab-burndown/error/not_implemented'
+require 'gitlab-burndown/generator/generator'
+require 'gitlab-burndown/writer/string'
+
+class CSVGenerator < Generator
+  def initialize(header)
+    super()
+    @header = header
+    @string_writer = StringWriter.new
+  end
+
+  def generate
+    @string_writer.write "#{@header}\n"
+    write_csv_body
+    @string_writer.read
+  end
+
+  def write_csv_body
+    raise NotImplementedError
+  end
+end

data/lib/gitlab-burndown/generator/generator.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/error/not_implemented'
+
+class Generator
+  def generate
+    raise NotImplementedError
+  end
+end

data/lib/gitlab-burndown/generator/issue_csv_generator.rb

@@ -0,0 +1,40 @@
+require 'gitlab-burndown/generator/csv_generator'
+require 'gitlab-burndown/csv_field/category'
+require 'gitlab-burndown/csv_field/closed_at'
+require 'gitlab-burndown/csv_field/closed_state'
+require 'gitlab-burndown/csv_field/fields'
+require 'gitlab-burndown/csv_field/hour_estimate'
+require 'gitlab-burndown/csv_field/iid'
+require 'gitlab-burndown/csv_field/in_sprint'
+require 'gitlab-burndown/csv_field/milestone'
+require 'gitlab-burndown/csv_field/title'
+require 'gitlab-burndown/csv_field/web_url'
+
+class IssueCSVGenerator < CSVGenerator
+  def initialize(issues)
+    super('IID;Title;Category;Milestone;Estimated hours;In current sprint;Is completed;Completed date;URL')
+    @issues = issues
+  end
+
+  def write_csv_body
+    @issues.each do |issue|
+      csv_line_builder = create_csv_line_builder_for_issue issue
+      @string_writer.write csv_line_builder.format
+    end
+  end
+
+  def create_csv_line_builder_for_issue(issue)
+    CSVFields.new(
+      issue,
+      IssueIIDCSVField,
+      IssueTitleCSVField,
+      IssueCategoryCSVField,
+      IssueMilestoneCSVField,
+      IssueHourEstimateCSVField,
+      IssueInSprintCSVField,
+      IssueClosedStateCSVField,
+      IssueClosedAtCSVField,
+      IssueWebURLCSVField
+    )
+  end
+end

data/lib/gitlab-burndown/gitlab/client.rb

@@ -0,0 +1,23 @@
+require 'gitlab-burndown/net/http/client'
+require 'gitlab-burndown/net/http/paginator'
+
+class GitlabHTTPClient < HTTPClient
+  def initialize(config)
+    token = config.get('GL_TOKEN')
+    host = config.get('GL_HOST')
+    api_version = config.get('GL_API_VERSION')
+    super(token)
+    @gitlab_api_host = "#{host}/api/#{api_version}"
+    @gitlab_group_id = config.get('GL_GROUP_ID')
+  end
+
+  def get_group_issues(gitlab_group_id)
+    paginate_group_issues(gitlab_group_id, nil)
+  end
+
+  def paginate_group_issues(_gitlab_group_id, _pagination)
+    base_url = "#{@gitlab_api_host}/groups/#{@gitlab_group_id}/issues?per_page=100&page="
+    paginator = HTTPPaginator.new(self, base_url, 'x-total-pages')
+    paginator.paginate(nil)
+  end
+end

data/lib/gitlab-burndown/net/http/client.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'net/http'
+require 'gitlab-burndown/net/http/response'
+
+class HTTPClient
+  def initialize(auth_token)
+    @auth_token = auth_token
+  end
+
+  def get(url)
+    uri = URI(url)
+    request = Net::HTTP::Get.new(uri)
+    request['PRIVATE-TOKEN'] = @auth_token
+    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http_context|
+      http_context.request(request)
+    end
+
+    HTTPResponse.new(response)
+  end
+end

data/lib/gitlab-burndown/net/http/paginator.rb

@@ -0,0 +1,22 @@
+Pagination = Struct.new(:page, :results)
+
+class HTTPPaginator
+  def initialize(client, base_url, header_total_pages)
+    @client = client
+    @base_url = base_url
+    @header_total_pages = header_total_pages
+  end
+
+  def paginate(pagination)
+    pagination = Pagination.new(1, []) if pagination.nil?
+    url = "#{@base_url}#{pagination.page}"
+    warn "Reading #{url}"
+    response = @client.get(url)
+    pagination.results.concat(response.json)
+
+    return pagination.results if response.header(@header_total_pages) == pagination.page.to_s
+
+    pagination.page += 1
+    paginate(pagination)
+  end
+end

data/lib/gitlab-burndown/net/http/response.rb

@@ -0,0 +1,21 @@
+class HTTPResponse
+  def initialize(builtin_response)
+    @builtin_response = builtin_response
+  end
+
+  def body
+    @builtin_response.body
+  end
+
+  def text
+    body
+  end
+
+  def json
+    JSON.parse(body)
+  end
+
+  def header(header_name)
+    @builtin_response[header_name]
+  end
+end

data/lib/gitlab-burndown/writer/file.rb

@@ -0,0 +1,14 @@
+require 'gitlab-burndown/writer/writer'
+
+class FileWriter < Writer
+  def initialize(filepath)
+    super()
+    @filepath = filepath
+  end
+
+  def write(content)
+    File.open(@filepath, 'w') do |file|
+      file.write content
+    end
+  end
+end

data/lib/gitlab-burndown/writer/string.rb

@@ -0,0 +1,16 @@
+require 'gitlab-burndown/writer/writer'
+
+class StringWriter < Writer
+  def initialize
+    super()
+    @string_result = ''
+  end
+
+  def write(content)
+    @string_result += content
+  end
+
+  def read
+    @string_result
+  end
+end

data/lib/gitlab-burndown/writer/writer.rb

@@ -0,0 +1,7 @@
+require 'gitlab-burndown/error/not_implemented'
+
+class Writer
+  def write(content)
+    raise NotImplementedError
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-burndown
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Andreas Kruhlmann
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-02-09 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email: andreas.kruehlmann@siemens.com
+executables:
+- gitlab-burndown
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gitlab-burndown
+- lib/gitlab-burndown/config/configuration.rb
+- lib/gitlab-burndown/config/env_file_configuration.rb
+- lib/gitlab-burndown/csv_field/category.rb
+- lib/gitlab-burndown/csv_field/closed_at.rb
+- lib/gitlab-burndown/csv_field/closed_state.rb
+- lib/gitlab-burndown/csv_field/field.rb
+- lib/gitlab-burndown/csv_field/fields.rb
+- lib/gitlab-burndown/csv_field/hour_estimate.rb
+- lib/gitlab-burndown/csv_field/iid.rb
+- lib/gitlab-burndown/csv_field/in_sprint.rb
+- lib/gitlab-burndown/csv_field/milestone.rb
+- lib/gitlab-burndown/csv_field/title.rb
+- lib/gitlab-burndown/csv_field/web_url.rb
+- lib/gitlab-burndown/error/illegal_access.rb
+- lib/gitlab-burndown/error/no_such_variable.rb
+- lib/gitlab-burndown/error/not_implemented.rb
+- lib/gitlab-burndown/fetcher/fetcher.rb
+- lib/gitlab-burndown/fetcher/group_issues.rb
+- lib/gitlab-burndown/filter/closed_after_date.rb
+- lib/gitlab-burndown/filter/filter.rb
+- lib/gitlab-burndown/filter/filter_list.rb
+- lib/gitlab-burndown/filter/no_include_labels.rb
+- lib/gitlab-burndown/generator/burndown_csv_generator.rb
+- lib/gitlab-burndown/generator/csv_generator.rb
+- lib/gitlab-burndown/generator/generator.rb
+- lib/gitlab-burndown/generator/issue_csv_generator.rb
+- lib/gitlab-burndown/gitlab/client.rb
+- lib/gitlab-burndown/net/http/client.rb
+- lib/gitlab-burndown/net/http/paginator.rb
+- lib/gitlab-burndown/net/http/response.rb
+- lib/gitlab-burndown/writer/file.rb
+- lib/gitlab-burndown/writer/string.rb
+- lib/gitlab-burndown/writer/writer.rb
+homepage: https://mo-gitlab.siemens.dk/sw-group/foundation/gitlab-burndown-csv-generator
+licenses:
+- Nonstandard
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.15
+signing_key:
+specification_version: 4
+summary: GitLab burndown chart generator
+test_files: []