schleuder-gitlab-ticketing-1.0.0/0000700000175000017500000000000013433530524015665 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/.gitlab-ci.yml0000600000175000017500000000265713433530524020335 0ustar georggeorg--- stages: - test cache: paths: - vendor # Jobs that start with a period are disabled # This is just a template, to be used further below in the individual ruby rspec job definitions .test_ruby: &test_ruby before_script: # Export APT env vars to cache packages archives and lists based on the current working directory - export APT_DIR=$CI_PROJECT_DIR/vendor/apt && export APT_ARCHIVES_DIR=$APT_DIR/archives && export APT_LISTS_DIR=$APT_DIR/lists # Configure APT: Only install necessary packages, set cache location - printf "apt::install-recommends 0;\n apt::install-suggests 0;\n dir::cache::archives ${APT_ARCHIVES_DIR};\n dir::state::lists ${APT_LISTS_DIR};\n" >> /etc/apt/apt.conf.d/99custom # Ensure the custom APT directory does exist - mkdir -p {${APT_ARCHIVES_DIR},${APT_LISTS_DIR}}/partial - apt-get update -qq - apt-get install -qq -y eatmydata - eatmydata gem install bundler - eatmydata bundle install --jobs $(nproc) --path vendor script: - eatmydata bundle exec rspec ruby:2.3: image: ruby:2.3 <<: *test_ruby ruby:2.4: image: ruby:2.4 <<: *test_ruby ruby:2.5: image: ruby:2.5 <<: *test_ruby ruby:2.6: image: ruby:2.6 <<: *test_ruby bundler:audit: image: ruby:2.5 only: - schedules script: - gem install bundler-audit - bundle install --jobs $(nproc) --path vendor - bundle-audit update - bundle-audit check schleuder-gitlab-ticketing-1.0.0/README.md0000600000175000017500000001435113433530524017152 0ustar georggeorgSchleuder Gitlab Ticketing ========================== A schleuder filter/plugin to hook lists into the issue tracker of a gitlab project. Background ---------- Schleuderlists are not only a helpful tool for communication within groups, they can also be used for newsletters, or by using its famous remailer capabilities to be used as a contact address for a project or as a help desk. In the latter two cases keeping an overview of the different interactions can become somewhat cumbersome, especially in a bigger collective where not everybody is able to dedicate the same amount of time/attention to the contact address / help desk. Hence it is easy that a certain thread (and so task) on the list is getting lost. Having some kind of ticketing system in place can help to easily keep track of what is done, what is in progress and what should be looked at. Additionally, folks do not like to double the work and hence as much as possible should be done while emails flow over the list. This schleuder filter / plugin allows to map emails through an id in the subject to issues in a gitlab project. Additionally, it opens an issue on new emails or closes issues if the subject indicates that the job is done. The gitlab issues are mainly used to keep the state of a certain email thread and contains only as much plaintext information as was transmitted in plaintext over the wire. This means it only stores From:, Subject: and Message-Id: as issue comments. How it works ------------ The filter / plugin hooks into the filter process list in schleuder. First schleuder will check whether there is a configuration for the current list, as well as whether this configuration is correct. Otherwise the filter is immediately skipped. Schleuder then dispatches the processing to the specific list instance, which checks whether the email comes from a sender that shall be ignored (e.g. well known spammers or announce lists) or whether the subject matches any of the configured subject filters. The email is also ignored if the well known `X-Spam-Flag` header is set to `yes`. If none of that matches, the email is being processed and first the email's subject is analyzed to get an already existing ticket id. The plugin expects something like `Subject: my subject [gp#123]`, where gp is a configureable project identifier and 123 matches an issue id in gitlab. The brackets enclose the ticket identifier and can be anywhere within the subject. If no ticket id can be found or no issue can be found in gitlab a new issue will be created in gitlab. The ticket id will be appended to the subject, a faulty ticket id will be replaced. If a ticket can be found, a comment is added to the issue, that includes the sender email address, as well as the Subject and Message-ID of the email. Additionally, if the email is sent from an email address, that is a member of the gitlab project the ticket will be assigned to said user. Furthermore, the label `inprocess` is added to ticket to indicate that someone of the project is working on that thread. If the ticket is already closed it will be re-opened. If the subject contains: `[ok]` the ticket will be closed and the label `inprocess` removed. An already closed ticket stays closed. That's it. Prerequisits ------------ * ruby >=2.1 * schleuder >= 3.3.0 * A working schleuder installation and a schleuder list * A gitlab project and a dedicated user and its API token Installation ------------ * Install the gem (depends on the gitlab gem) * Link `lib/schleuder/filters/post_decrpytion/99_gitlab_ticketing.rb` into `/usr/local/lib/schleuder/filters/post_decryption/`, so the plugin gets loaded. Configuration ------------- The plugin is looking for a configuration in `/etc/schleuder/gitlab.yml`. The configuration file expects a `gitlab` and a lists `configuration` section: ``` gitlab: endpoint: https://gitlab.example.com/api/v4 token: xxxx lists: test@schleuder.example.com: project: tickets namespace: support ``` The key of the lists configuration indicates the listname on schleuder side, which matches its email address. A list's setting requires 2 configuration options: `project` & `namespace` which map to the path within gitlab, where the project exists. Namespace can either be the group or the users name, depending of where a project lives. The plugin supports working for multiple lists, as well as allows individual gitlab configuration for different lists: ``` gitlab: endpoint: https://gitlab.example.com/api/v4 token: xxxx lists: test@schleuder.example.com: project: tickets namespace: support test2@schleuder.example.com: gitlab: endpoint: https://gitlab2.example.com/api/v4 token: aaaa ``` Additionally, you can specify filters based on the sender or the subject. They must be valid ruby regexps and can also be specified on a global and local level. ``` gitlab: endpoint: https://gitlab.example.com/api/v4 token: xxxx subject_filters: - '\[announce\]' sender_filters: - '^spammer@example\.com$' lists: test@schleuder.example.com: project: tickets namespace: support subject_filters: - 'ignore me' test2@schleuder.example.com: gitlab: endpoint: https://gitlab2.example.com/api/v4 token: aaaa sender_filters: - 'noreply@example\.com' ``` Additionally, you can specify a specifc identifier to more easily identify a particular ticket id in the subject: ``` lists: test@schleuder.example.com: project: tickets namespace: support ticket_prefix: ourid ``` This will look for the following string in a subject: `[ourid#\d+]`. By default it would look for: `[gl/test#\d+]` Todo ---- This plugin is in a working state and has been tested by multiple use cases for nearly a year. Some more ideas: * Use schleuder's verification capabilities to further prove that the email comes from a list member. * Hook into schleuder's plugin capabilities, to allow more ticket actions (e.g. assign, labels, ...) Contributing ------------ Please see [CONTRIBUTING.md](CONTRIBUTING.md). Mission statement ----------------- Please see [MISSION_STATEMENT.md](MISSION_STATEMENT.md). Code of Conduct --------------- We adopted a code of conduct. Please read [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). License ------- GNU GPL 3.0. Please see [LICENSE.txt](LICENSE.txt). schleuder-gitlab-ticketing-1.0.0/CHANGELOG.md0000600000175000017500000000020613433530524017476 0ustar georggeorgChange Log ========== This project adheres to [Semantic Versioning](http://semver.org/). ## [1.0.0] / 2019-02-21 * initial release schleuder-gitlab-ticketing-1.0.0/schleuder-gitlab-ticketing.gemspec0000600000175000017500000000352613433530524024437 0ustar georggeorg# encoding: utf-8 $: << File.expand_path('../lib', __FILE__) require 'schleuder-gitlab-ticketing/version' Gem::Specification.new do |s| s.name = "schleuder-gitlab-ticketing" s.version = SchleuderGitlabTicketing::VERSION s.authors = 'schleuder dev team' s.email = "team@schleuder.org" s.homepage = "https://schleuder.org/" s.summary = "Schleuder Gitlab Ticketing is a filter plugin for schleuder to hook a list into a gitlab issue tracker" s.description = "Schleuder Gitlab Ticketing combines a schleuder list with the issue tracker of a gitlab project and operates as a state tracker of threads on the list. This allows one to keep an overview on the state of various requests on a help desk powered by schleuder" s.files = `git ls-files lib README.md`.split s.executables = %w[] s.platform = Gem::Platform::RUBY s.require_path = 'lib' s.rubyforge_project = '[none]' s.license = 'GPL-3.0' s.metadata = { "homepage_uri" => "https://schleuder.org/", "documentation_uri" => "https://schleuder.org/docs/", "changelog_uri" => "https://0xacab.org/schleuder/schleuder-gitlab-ticketing/blob/master/CHANGELOG.md", "source_code_uri" => "https://0xacab.org/schleuder/schleuder-gitlab-ticketing/", "bug_tracker_uri" => "https://0xacab.org/schleuder/schleuder-gitlab-ticketing/issues", "mailing_list_uri" => "https://lists.nadir.org/mailman/listinfo/schleuder-announce/", } s.required_ruby_version = ">= 2.1.0" s.add_runtime_dependency 'gitlab', '~> 4.8' s.add_runtime_dependency 'schleuder', '~> 3.3' s.add_development_dependency 'rspec', '~> 3.5' s.post_install_message = " To activate the filter plugin you will need to link lib/schleuder/filters/post_decryption/99_gitlab_ticketing.rb to /usr/local/lib/schleuder/filters/post_decryption/ " end schleuder-gitlab-ticketing-1.0.0/MISSION_STATEMENT.md0000600000175000017500000000135313433530524020760 0ustar georggeorg# Schleuder's Mission Statement We give our time and knowledge to build and maintain this project in order to help people with their daily private communication and in the struggle for their personal emancipation, social and economic justice and political freedom. A more human world, in which anyone can be different without fear, is what we strive for. We work transparently and responsibly, and don't collaborate with surveillance actors. We do not endorse any form of authoritarian movement or totalitarian system, and wish for that Schleuder may not ever be used to promote or enable them. Instead we are committed to ideas and principles outlined in our [Code of Conduct](CODE_OF_CONDUCT.md). If you do not agree, do not use Schleuder. schleuder-gitlab-ticketing-1.0.0/Gemfile0000600000175000017500000000016013433530524017157 0ustar georggeorgsource 'https://rubygems.org' # Specify your gem's dependencies in schleuder-gitlab-ticketing.gemspec gemspec schleuder-gitlab-ticketing-1.0.0/Rakefile0000600000175000017500000000572613433530524017346 0ustar georggeorgproject = 'schleuder-gitlab-ticketing' require_relative "lib/#{project}.rb" @version = SchleuderGitlabTicketing::VERSION @tagname = "schleuder-gitlab-ticketing-#{@version}" @gpguid = 'team@schleuder.org' @filename_gem = "#{@tagname}.gem" @filename_tarball = "#{@tagname}.tar.gz" @gpg=File.exists?('/usr/bin/gpg2') ? '/usr/bin/gpg2' : '/usr/bin/gpg' def edit_and_add_file(filename) puts "Please edit #{filename} to refer to version #{@version}" if system("gvim -f #{filename}.md") `git add #{filename}.md` else exit 1 end end task :console do exec "irb -r #{File.dirname(__FILE__)}/lib/#{project}.rb" end task :publish_gem => :website task :git_tag => :check_version desc "Build new version: git-tag and gem-file" task :new_version => [ :check_version, :edit_readme, :edit_changelog, :git_add_version, :git_commit, :build_gem, :sign_gem, :build_tarball, :sign_tarball, :git_tag ] do end desc "Edit CHANGELOG.md" task :edit_changelog do edit_and_add_file('CHANGELOG') end desc "Edit README" task :edit_readme do edit_and_add_file('README') end desc 'git-tag HEAD as new version' task :git_tag do `git tag -u #{@gpguid} -s -m "Version #{@version}" #{@tagname}` end desc "Add changed version to git-index" task :git_add_version do `git add lib/#{project}/version.rb` end desc "Commit changes as new version" task :git_commit do `git commit -m "Version #{@version}"` end desc 'Build, sign and commit a gem-file.' task :build_gem do `gem build schleuder-gitlab-ticketing.gemspec` end desc 'OpenPGP-sign gem and tarball' task :sign_tarball do `#{@gpg} -u #{@gpguid} -b #{@filename_tarball}` end desc 'OpenPGP-sign gem' task :sign_gem do `#{@gpg} -u #{@gpguid} -b #{@filename_gem}` end desc 'Upload download-files (gem, tarball, signatures) to schleuder.org.' task :upload_files do # Use rsync to ensure correct file permissions on the server (scp overwrites umask, ACL, etc.). puts `rsync -v -t --chmod=ugo=rwX #{@tagname}* schleuder.org:/var/www/download/ 2>&1` end desc 'Publish gem-file to rubygems.org' task :publish_gem do puts "Really push #{@filename_gem} to rubygems.org? [yN]" if gets.match(/^y/i) puts "Pushing..." `gem push #{@filename_gem}` else puts "Not pushed." end end desc 'Build and sign a tarball' task :build_tarball do `git archive --format tar.gz --prefix "#{@tagname}/" -o #{@filename_tarball} master` end desc 'Describe manual release-tasks' task :website do puts "Please remember to publish the release-notes on the website and on schleuder-announce." end desc 'Check if version-tag already exists' task :check_version do # Check if Schleuder::VERSION has been updated since last release if `git tag`.match?(/^#{@tagname}$/) $stderr.puts "Warning: Tag '#{@tagname}' already exists. Did you forget to update #{project}/version.rb?" $stderr.print "Delete tag to continue? [yN] " if $stdin.gets.match(/^y/i) `git tag -d #{@tagname}` else exit 1 end end end schleuder-gitlab-ticketing-1.0.0/spec/0000700000175000017500000000000013433530524016617 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/spec/schleuder_spec.rb0000600000175000017500000000746013433530524022145 0ustar georggeorgrequire 'spec_helper' require 'schleuder/filters/post_decryption/99_gitlab_ticketing' describe Schleuder::Filters do context 'with talking to gitlab' do let(:config){ SchleuderGitlabTicketing::Config.new('spec/fixtures/gitlab.yml') } let(:new_ticket) { double } let(:gitlab) { double } let(:list) { double } let(:mail) { MailStub.new('user@example.com','question') } before(:each) do # reset the mocked classes so they don't leak to other tests Schleuder::Filters.instance_variable_set('@gt_config',nil) allow(SchleuderGitlabTicketing::Config).to receive(:new).and_return(config) allow_any_instance_of(SchleuderGitlabTicketing::List).to receive(:gitlab).and_return(gitlab) list1_project = double allow(list1_project).to receive(:name).and_return('tickets') allow(list1_project).to receive(:id).and_return(123) allow(list1_project).to receive_message_chain(:namespace,:name).and_return('support') allow(gitlab).to receive(:search_projects).with('tickets').and_return([list1_project]) end context 'with processing' do before(:each) do expect(list).to receive(:email).and_return('test') expect(gitlab).to receive(:create_issue).with(123,'question',{ description: "From: user@example.com\n\nMessage-Id: 1-abc-3\n\nSubject: question"}).and_return(new_ticket) end it 'creates a new ticket' do expect(new_ticket).to receive(:iid).and_return(42) expect(new_ticket).to receive(:state).and_return('open') expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('question [gl/tickets#42]') end it 'works even on en exception' do expect(new_ticket).to receive(:iid).and_raise(Exception,'internal test error') logger = double expect(list).to receive(:logger).and_return(logger) expect(logger).to receive(:notify_admin) expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('question') end end context 'subject filter' do let(:mail) { MailStub.new('user@example.com','ignore me') } it 'skips email if subject filter matches' do logger = double expect(list).to receive(:logger).and_return(logger) expect(logger).to receive(:debug).with('Email skipped by list configuration') expect(list).to receive(:email).and_return('test') expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('ignore me') end end context 'sender filter' do let(:mail) { MailStub.new('test@example.com','like me') } it 'skips email if subject filter matches' do logger = double expect(list).to receive(:logger).and_return(logger) expect(logger).to receive(:debug).with('Email skipped by list configuration') expect(list).to receive(:email).and_return('test') expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('like me') end end it 'skips non configured lists' do expect(list).to receive(:email).and_return('non-existing-test') logger = double expect(list).to receive(:logger).and_return(logger) expect(logger).to receive(:debug).with('No gitlab ticketing enabled for list') expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('question') end it 'skips on wrongly configured lists' do expect(list).to receive(:email).and_return('invalid1') logger = double expect(list).to receive(:logger).and_return(logger) expect(logger).to receive(:error) expect(Schleuder::Filters.gitlab_ticketing(list, mail)).to be(nil) expect(mail.subject).to eql('question') end end end schleuder-gitlab-ticketing-1.0.0/spec/config_spec.rb0000600000175000017500000000512113433530524021424 0ustar georggeorgrequire 'spec_helper' describe SchleuderGitlabTicketing::Config do describe 'non existing config' do let(:config){ SchleuderGitlabTicketing::Config.new('spec/fixtures/gitlab.yml.nonexistent') } context 'with a config' do it 'provides a way to process a list' do expect(config).to respond_to(:process_list) end it 'loads the configured lists' do expect(config.lists.length).to eql(0) end end end describe 'basic' do let(:config){ SchleuderGitlabTicketing::Config.new('spec/fixtures/gitlab.yml') } context 'with a config' do it 'provides a way to process a list' do expect(config).to respond_to(:process_list) end it 'loads the configured lists' do expect(config.lists.length).to eql(8) expect(config.lists.values.first).to be_instance_of(SchleuderGitlabTicketing::List) end end context 'gitlab config' do it 'adds the global gitlab config to all the lists' do test_list = config.lists['test'] expect(test_list.gitlab.endpoint).to eql('https://gitlab.example.com/api/v4') expect(config.lists['invalid1'].gitlab).to eql(test_list.gitlab) end it 'supports dedicated gitlabs for certain lists' do test_list = config.lists['test2'] expect(test_list.gitlab.endpoint).to eql('https://gitlab2.example.com/api/v4') expect(config.lists['invalid1'].gitlab).to_not eql(test_list.gitlab) end end context 'merging filters' do it 'merges global and local subject filters' do test_list = config.lists['test'] expect(test_list.subject_filters.length).to eql(2) expect(test_list.subject_filters).to include('\[announce\]') expect(test_list.subject_filters).to include('ignore me') test_list = config.lists['test2'] expect(test_list.subject_filters.length).to eql(1) expect(test_list.subject_filters).to include('\[announce\]') expect(test_list.subject_filters).to_not include('ignore me') end it 'merges global and local sender filters' do test_list = config.lists['test2'] expect(test_list.sender_filters.length).to eql(2) expect(test_list.sender_filters).to include('^test@example\.com$') expect(test_list.sender_filters).to include('noreply@example\.com') test_list = config.lists['test'] expect(test_list.sender_filters.length).to eql(1) expect(test_list.sender_filters).to include('^test@example\.com$') expect(test_list.sender_filters).to_not include('noreply@example\.com') end end end end schleuder-gitlab-ticketing-1.0.0/spec/list_spec.rb0000600000175000017500000005423613433530524021145 0ustar georggeorgrequire 'spec_helper' describe SchleuderGitlabTicketing::List do let(:config){ SchleuderGitlabTicketing::Config.new('spec/fixtures/gitlab.yml') } let(:list1){ config.lists['test'] } describe 'basic' do context 'with a config' do it 'provides a way to process a mail' do expect(list1).to respond_to(:process) end it 'provides a way to check if it\'s configured properly' do expect(list1).to respond_to(:configured?) end it 'has a gitlab config' do expect(list1).to respond_to(:gitlab) expect(list1.gitlab).to be_an_instance_of(Gitlab::Client) end it 'loads the configured lists' do expect(config.lists.length).to eql(8) expect(config.lists.values.first).to be_instance_of(SchleuderGitlabTicketing::List) end it 'has sender filters' do expect(list1).to respond_to(:sender_filters) expect(list1.sender_filters).to be_a(Array) expect(list1.sender_filters.length).to eql(1) end it 'has subject filters' do expect(list1).to respond_to(:subject_filters) expect(list1.subject_filters).to be_a(Array) expect(list1.subject_filters.length).to eql(2) end end end context 'with talking to gitlab' do let(:gitlab) { double } context 'list properly configured?' do context 'with projects on gitlab' do before(:each) do allow_any_instance_of(SchleuderGitlabTicketing::List).to receive(:gitlab).and_return(gitlab) list1_project = double allow(list1_project).to receive(:name).and_return('tickets') allow(list1_project).to receive(:id).and_return(123) allow(list1_project).to receive_message_chain(:namespace,:name).and_return('support') list2_project = double allow(list2_project).to receive(:name).and_return('testing') allow(list2_project).to receive_message_chain(:namespace,:name).and_return('support') allow(gitlab).to receive(:search_projects).with('tickets').and_return([list1_project]) allow(gitlab).to receive(:search_projects).with('testing').and_return([list2_project]) allow(gitlab).to receive(:search_projects).with('tickets2').and_return([list2_project]) allow_any_instance_of(Gitlab::Error::NotFound).to receive(:build_error_message).and_return('bla') allow(gitlab).to receive(:search_projects).with('tickets3').and_raise(Gitlab::Error::NotFound,'bla') end it 'labels correct lists properly' do expect(config.lists['test'].configured?).to be(true) expect(config.lists['test2'].configured?).to be(true) expect(config.lists['test_not_exist'].configured?).to be(false) expect(config.lists['test_not_exist2'].configured?).to be(false) end end context 'with missing config' do it 'fails' do expect(config.lists['invalid1'].configured?).to be(false) expect(config.lists['invalid2'].configured?).to be(false) expect(config.lists['invalid3'].configured?).to be(false) expect(config.lists['invalid4'].configured?).to be(false) end end end context 'processing mails' do before(:each) do allow_any_instance_of(SchleuderGitlabTicketing::List).to receive(:gitlab).and_return(gitlab) list1_project = double allow(list1_project).to receive(:name).and_return('tickets') allow(list1_project).to receive(:id).and_return(123) allow(list1_project).to receive_message_chain(:namespace,:name).and_return('support') allow(list1_project).to receive_message_chain(:namespace,:id).and_return(91) allow(gitlab).to receive(:search_projects).with('tickets').and_return([list1_project]) end context 'ignores spam' do it 'drops spam' do m = MailStub.new('bla@example.com','Some subject',{ 'X-Spam-Flag' => 'yes' }) expect(list1.process(m)).to be(false) end it 'drops spam case-insensitiv' do m = MailStub.new('bla@example.com','Some subject',{ 'X-Spam-Flag' => 'YES' }) expect(list1.process(m)).to be(false) end end context 'ignores certain senders' do it 'by regexp' do m = MailStub.new('test@example.com','Some subject') expect(list1.process(m)).to be(false) end end context 'ignores certain subjects' do it 'by regexp' do m = MailStub.new('test2@example.com','Some subject - ignore me') expect(list1.process(m)).to be(false) end it 'by regexp 2' do m = MailStub.new('test2@example.com','[announce] exciting') expect(list1.process(m)).to be(false) end it 'works if there is no subject' do m = MailStub.new('test2@example.com',nil) expect(list1.send(:ignore_mail?,m)).to be(false) end end context 'with a proper list' do it 'creates a new ticket' do m = MailStub.new('user@example.com','question') expect(gitlab).not_to receive(:user_search) new_ticket = double expect(new_ticket).to receive(:iid).and_return(42) expect(new_ticket).to receive(:state).and_return('open') expect(gitlab).to receive(:create_issue).with(123,'question',{ description: "From: user@example.com\n\nMessage-Id: 1-abc-3\n\nSubject: question"}).and_return(new_ticket) expect(list1.process(m)).to be(true) expect(m.subject).to eql('question [gl/tickets#42]') end it 'creates a new ticket with an empty subject' do m = MailStub.new('user@example.com',nil) expect(gitlab).not_to receive(:user_search) new_ticket = double expect(new_ticket).to receive(:iid).and_return(42) expect(new_ticket).to receive(:state).and_return('open') expect(gitlab).to receive(:create_issue).with(123,'Request from user@example.com',{ description: "From: user@example.com\n\nMessage-Id: 1-abc-3\n\nSubject: [not set]"}).and_return(new_ticket) expect(list1.process(m)).to be(true) expect(m.subject).to eql('[gl/tickets#42]') end it 'creates a new ticket with a nearly empty subject' do m = MailStub.new('user@example.com','[ok]') expect(gitlab).not_to receive(:user_search) new_ticket = double expect(new_ticket).to receive(:iid).and_return(42) expect(new_ticket).to receive(:state).and_return('open') expect(gitlab).to receive(:create_issue).with(123,'Request from user@example.com',{ description: "From: user@example.com\n\nMessage-Id: 1-abc-3\n\nSubject: [ok]"}).and_return(new_ticket) expect(gitlab).to receive(:edit_issue).with(123,42,{ state_event: 'close', labels: '' }) expect(list1.process(m)).to be(true) expect(m.subject).to eql('[ok] [gl/tickets#42]') end it 'creates a new ticket with a nearly empty subject 2' do m = MailStub.new('user@example.com','[ CI / CD -> Expand next to Runners settings -> Enable shared Runners. 4. Commit in rather small chunks but don't split depending code across commits. Please write sensible commit messages. 5. Please add tests for your feature or bugfix. 6. If in doubt request feedback from us! 7. When finished create a merge request. Thank you for your interest! schleuder-gitlab-ticketing-1.0.0/LICENSE.txt0000600000175000017500000010451313433530524017516 0ustar georggeorg GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . schleuder-gitlab-ticketing-1.0.0/lib/0000700000175000017500000000000013433530524016433 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing.rb0000600000175000017500000000025613433530524024162 0ustar georggeorg module SchleuderGitlabTicketing end require 'schleuder-gitlab-ticketing/gitlab_config' require 'schleuder-gitlab-ticketing/config' require 'schleuder-gitlab-ticketing/list' schleuder-gitlab-ticketing-1.0.0/lib/schleuder/0000700000175000017500000000000013433530524020411 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/lib/schleuder/filters/0000700000175000017500000000000013433530524022061 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/lib/schleuder/filters/post_decryption/0000700000175000017500000000000013433530524025306 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/lib/schleuder/filters/post_decryption/99_gitlab_ticketing.rb0000600000175000017500000000161613433530524031465 0ustar georggeorgmodule Schleuder module Filters def self.gitlab_ticketing(list, mail) @gt_config ||= begin require 'schleuder-gitlab-ticketing' SchleuderGitlabTicketing::Config.new end res = @gt_config.process_list(list.email, mail) if res.nil? list.logger.debug('No gitlab ticketing enabled for list') elsif res == 'config-error' list.logger.error('gitlab ticketing not correctly configured') elsif res == false list.logger.debug('Email skipped by list configuration') end nil # make sure we catch any error with that filter # so we don't affect list processing rescue Exception => e list.logger.notify_admin "Unable to process the following mail with gitlab-ticketing:\n\n#{e}\n\n#{e.backtrace.join("\n")}", mail.original_message, 'Error while processing mail with gitlab-ticketing' nil end end end schleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing/0000700000175000017500000000000013433530524023630 5ustar georggeorgschleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing/version.rb0000600000175000017500000000007013433530524025641 0ustar georggeorgmodule SchleuderGitlabTicketing VERSION = '1.0.0' end schleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing/config.rb0000600000175000017500000000222113433530524025421 0ustar georggeorgmodule SchleuderGitlabTicketing class Config include SchleuderGitlabTicketing::GitlabConfig def initialize(config_path='/etc/schleuder/gitlab.yml') @config = if File.exists?(config_path) YAML.load_file(config_path) else {} end end # returns true if mail was handled # returns 'config-error' if list-config is not properly # returns nil if list is not configured to handle # gitlab plugin def process_list(list_name, mail) if l = lists[list_name] if l.configured? l.process(mail) else 'config-error' end else nil end end def lists @lists ||= read_lists end private def read_lists Hash(@config['lists']).inject({}) do |res,a| n,v = a v['gitlab'] ||= gitlab v['subject_filters'] = Array(v['subject_filters']) + Array(@config['subject_filters']) v['sender_filters'] = Array(v['sender_filters']) + Array(@config['sender_filters']) res[n] = SchleuderGitlabTicketing::List.new(n,v) res end end end end schleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing/gitlab_config.rb0000600000175000017500000000046313433530524026751 0ustar georggeorgmodule SchleuderGitlabTicketing module GitlabConfig def gitlab @gitlab ||= if @config['gitlab']['endpoint'] && @config['gitlab']['token'] Gitlab.client(endpoint: @config['gitlab']['endpoint'], private_token: @config['gitlab']['token']) else nil end end end end schleuder-gitlab-ticketing-1.0.0/lib/schleuder-gitlab-ticketing/list.rb0000600000175000017500000001237313433530524025140 0ustar georggeorgrequire 'yaml' require 'gitlab' require 'set' module SchleuderGitlabTicketing class List include SchleuderGitlabTicketing::GitlabConfig def initialize(name, config) @name = name @config = config end def configured? unless @config['project'] && @config['namespace'] && @config['gitlab'] && gitlab && project return false end true end def process(mail) return false if ignore_mail?(mail) ticket_id = get_ticket_id(mail.subject) ticket = ticket_id ? get_ticket(ticket_id) : nil if (title = clean_subject(mail.subject)).nil? || title.empty? title = "Request from #{mail.from.first}" end desc = desc(mail) updates = {} labels = Set.new if !ticket ticket = create_ticket(title, desc) ticket_id = ticket.iid mail.subject = update_subject(mail.subject, ticket_id) else labels = Set.new(ticket.labels) comment_ticket(ticket_id,desc) assignee_id = team_member_id(mail.from.first) if assignee_id && ((as = ticket.assignee).nil? || as.id != assignee_id) updates[:assignee_id] = assignee_id end end bc = be_closed?(mail.subject) tc = ticket_closed?(ticket) if !tc && bc labels.delete('inprocess') updates[:state_event] = 'close' elsif !tc && !bc labels << 'inprocess' if updates[:assignee_id] elsif tc && !bc labels << 'inprocess' updates[:state_event] = 'reopen' end if labels.empty? && (updates[:state_event] == 'close') # make sure we remove the inprocess label updates[:labels] = '' elsif !labels.empty? && (labels.to_a.sort != ticket.labels.sort) updates[:labels] = labels.to_a.join(',') end update_ticket(ticket_id, updates) true end def gitlab @gitlab ||= if @config['gitlab'].is_a?(Gitlab::Client) @config['gitlab'] else super end end def sender_filters Array(@config['sender_filters']) end def subject_filters Array(@config['subject_filters']) end private def desc(mail) res = [] res << "From: #{mail.from.first}" res << "Message-Id: #{mail.message_id}" res << "Subject: #{mail.subject || '[not set]'}" res.join("\n\n") end def be_closed?(subject) !(subject =~ /\[ok\]/).nil? end def ticket_closed?(ticket) ticket.state == 'closed' end def update_ticket(ticket_id,updates) return if updates.empty? gitlab.edit_issue(project.id, ticket_id, updates) rescue Gitlab::Error::NotFound => e nil end def create_ticket(title, desc) opts = { description: desc } gitlab.create_issue(project.id, title, opts) end def comment_ticket(ticket_id, desc) gitlab.create_issue_note(project.id, ticket_id, desc) end def get_ticket(id) gitlab.issue(project.id, id) rescue Gitlab::Error::NotFound => e nil end def get_ticket_id(str) if str && (m = str.match(/.*\[#{Regexp.escape(ticket_prefix)}\#(\d+)\].*/)) && m[1] m[1].to_i else nil end end def project @project ||= gitlab.search_projects(@config['project']).find{|p| p.namespace.name == @config['namespace'] && p.name == @config['project'] } rescue Gitlab::Error::NotFound => e nil end def issues gitlab.issues(p.id) end def team_member_id(email) if user_id = find_user_id(email) user_id if project_member?(project, user_id) else nil end rescue Gitlab::Error::NotFound => e nil end def project_member?(project, user_id) begin gitlab.team_member(project.id, user_id) rescue Gitlab::Error::NotFound gitlab.group_member(project.namespace.id, user_id) end rescue Gitlab::Error::NotFound => e nil end def find_user_id(username_or_email) users = gitlab.user_search(username_or_email) # did we look for an email => exact match # or by username? user = if username_or_email =~ /@/ users.first else users.find do |u| u.name == username_or_email || u.username == username_or_email end end user.nil? ? nil : user.id rescue Gitlab::Error::NotFound => e nil end def ignore_mail?(mail) return true if mail.respond_to?(:[]) && mail['X-Spam-Flag'].to_s.downcase == 'yes' return true if sender_filters.any?{|s| mail.from.first =~ /#{s}/ } return true if subject_filters.any?{|s| mail.subject =~ /#{s}/ } false end def ticket_prefix @ticket_prefix ||= (@config['ticket_prefix'] || "gl/#{@config['project']}") end def clean_subject(subj) subj.nil? ? nil : subj.gsub(/^(Re|Fw):\s*/,'').gsub(/\[[<>]?#{list_subj}\]\s*/,'').gsub(/\s*\[#{Regexp.escape(ticket_prefix)}#\d+\](\s*$)?/,'').gsub(/\s*\[ok\](\s*$)?/,'').strip end def list_subj @list_subj ||= (@config['list_subj'] || @name.split('@',2).first) end def update_subject(subject,ticket_id) [subject.nil? ? nil : subject.gsub(/(\s)?\[#{Regexp.escape(ticket_prefix)}#\d+\]/,''), "[#{ticket_prefix}##{ticket_id}]"].compact.join(' ') end end end schleuder-gitlab-ticketing-1.0.0/CODE_OF_CONDUCT.md0000600000175000017500000000440313433530524020467 0ustar georggeorg# Schleuder's Code of Conduct The Schleuder development team wants to provide an open and welcoming environment for everyone who participates in the development of Schleuder regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, physical appearance, race, ethnicity, economic or social status, age, religion, or nationality. Harassment in code and discussion or violation of physical boundaries is completely unacceptable anywhere in the Schleuder project. We welcome contributions from everyone that adheres to these principles. Violators will be warned, blocked or banned by the development team. ### In detail Harassment includes offensive verbal comments related to level of experience, gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, race, ethnicity, age, religion, nationality, the use of sexualized language or imagery, deliberate intimidation, stalking, sustained disruption, and unwelcome sexual attention. Individuals asked to stop any harassing behavior are expected to comply immediately. Maintainers, including the development team, are also subject to the anti-harassment policy. If anyone engages in abusive, harassing, or otherwise unacceptable behavior, including maintainers, we will take appropriate action, up to and including warning the offender, deletion of comments, removal from the project’s codebase and communication systems. If you are being harassed, notice that someone else is being harassed, or have any other concerns, please [contact the development team](https://schleuder.org/contact.html) immediately. We expect everyone to follow these rules anywhere in the Schleuder project’s codebases, issue trackers, IRC channel, group chat, mailing lists, meetups, and any other events. This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Finally, don't forget that it is human to make mistakes! We all do. Let’s work together to help each other, resolve issues, and learn from the mistakes that we will all inevitably make from time to time. ### Thanks Thanks to the [Bundler Code of Conduct](https://bundler.io/conduct.html), which we adopted for ourselves.