gitlab-mail-receiver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ff6d380ad5fe4c2cd3ff4066cfa4c371907a20c
+  data.tar.gz: f3018919650a3ac10e1bc1bbe30a4810430edee8
+SHA512:
+  metadata.gz: 45eaca00bbd532de05c158f898cf3b9e2cfb05d84ad9069b2e18ef661f44b04c884e4d52e02030b9d90356033f751639f765f937e92e59b49bbf554bd3767b93
+  data.tar.gz: 3c186bb6c06e452f6b1c3d2929f145d3053da9ab311ce1440af0460a7e9c8e7644ffe9743a31a5fba1f693438a8030cf441307cb6a6614ad9dd8bf4bb61d9f04

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Li Huashun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# GitLab Mail Receiver
+
+This gem can allow your GitLab to receive emails to create Issue comments like GitHub.
+
+[中文介绍](https://ruby-china.org/topics/27143)
+
+## Features
+
+- Receive Email reply to check Issue/MergeRequest and create comment.
+- Very easy to configure on GitLab project.
+- Cleanup the mail content.
+
+The WorkFlow:
+
+```
+                 /-->  [ Notify ] ----------------> [Mail Server] <---> [Mail Client]
+  { GitLab } ---/                                         ^
+       ^                                                  |
+       |-------< [ gitlab-mail-receiver ] <---- check --> |
+```
+
+## Requirements
+
+- GitLab 7.13 (I just tested on this version.)
+- A Email can receive mail via POP3/IMAP.
+
+
+## Configuration
+
+Add this gem in GitLab project Gemfile:
+
+```rb
+gem 'gitlab-mail-receiver'
+```
+
+Create initialize file in GitLab `config/initializes/gitlab-mail-receiver.rb`:
+
+```rb
+require 'gitlab-mail-receiver'
+
+Notify.send(:prepend, MailReceiver::ReplyTo)
+
+MailReceiver.configure do
+  self.sender = 'xxx@your-mail-host.com'
+  self.poll_interval = 5
+  self.imap = {
+    server: 'imap.your-mail-host.com'
+    port: 993
+    ssl: true
+    username: 'xxx@your-mail-host.com'
+    password: 'your-password'
+  }
+end
+```
+
+## Run
+
+```
+$ cd gitlab
+$ bundle exec gitlab-mail-receiver
+```
+
+> NOTE: The daemon log will write to `$rails_root/log/gitlab-mail-receiver.log`
+
+## Run in production
+
+```
+$ cd gitlab
+$ RAILS_ENV=production nohup bundle exec gitlab-mail-receiver &
+```

data/bin/gitlab-mail-receiver

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler/setup'
+require_relative '../lib/gitlab-mail-receiver'
+
+app_root = ENV['GITLAB_ROOT'] || "."
+
+begin
+  rails_env = ::File.expand_path('./config/environment', app_root)
+  require rails_env
+rescue => e
+  puts "You need run this command under GitLab root."
+  return
+end
+
+logger = Logger.new(File.join(app_root, 'log/gitlab-mail-receiver.log'))
+Mailman.config.logger = logger
+Mailman.config.rails_root = app_root
+
+logger.info "Starting Mailman ..."
+Mailman::Application.run do
+  to '%user%+%suffix%@%host%' do
+    @receiver = MailReceiver::Receiver.new(message, logger: logger)
+    @receiver.process!
+  end
+end

data/lib/gitlab-mail-receiver.rb

@@ -0,0 +1,21 @@
+require_relative './mail-receiver/body_parser'
+require_relative './mail-receiver/receiver'
+require_relative './mail-receiver/reply_to'
+require "mailman"
+require 'active_support/core_ext'
+
+module MailmanConfig
+  extend ActiveSupport::Concern
+
+  included do
+    attr_accessor :sender
+  end
+end
+
+Mailman::Configuration.send(:include, MailmanConfig)
+
+module MailReceiver
+  def self.configure(&block)
+    Mailman.config.instance_exec(&block)
+  end
+end

data/lib/gitlab-mail-receiver/railtie.rb

@@ -0,0 +1,7 @@
+module GitLabMailReceiver
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+    end
+  end
+end

data/lib/mail-receiver/body_parser.rb

@@ -0,0 +1,23 @@
+# Mail body context parser
+module MailReceiver
+  module BodyParser
+    # might need: mail.body.split(‘—-Original Message-—‘)[0].reverse.split(‘nO’)[-1].reverse for Outlook
+    def extract
+      self.decoded_part.
+      # Most providers start it off with that "On" date line.
+      reverse.split(' nO')[-1].reverse.
+      # Fancy sigs and sigs need to be discarded
+      split(/^-*/).first.chomp.
+      # Strip leading and trailing whitespace
+      strip
+    end
+
+    def decoded_part
+      self.part.decoded
+    end
+
+    def part
+      self.mail.multipart? ? self.mail.parts.first.body : self.mail.body
+    end
+  end
+end

data/lib/mail-receiver/receiver.rb

@@ -0,0 +1,115 @@
+module MailReceiver
+  class Receiver
+    include BodyParser
+
+    def initialize(message, opts = {})
+      @message = message
+      @logger = opts[:logger]
+    end
+
+    def mail
+      @message
+    end
+
+    def project_slug
+      @project_slug ||= id_prefix.split(/!|#/).first
+    end
+
+    def issue_id
+      @issue_id ||= id_prefix.split(/!|#/).last
+    end
+
+    def merge_request?
+      @merge_request ||= id_prefix.match('!')
+    end
+
+    def body
+      return @body if defined?(@body)
+      @body = self.extract
+      @body
+    end
+
+    def to
+      @to ||= @message.to.is_a?(Array) ? @message.to.first : @message.to
+    end
+
+    def from
+      @from ||= @message.from.is_a?(Array) ? @message.from.first : @message.from
+    end
+
+    # foo@gmail.com => foo
+    def prefix
+      @prefix ||= to.split('@').first
+    end
+
+    def inspect
+      { project_slug: project_slug, issue_id: issue_id, merge_request: merge_request?, to: to, body: body}
+    end
+
+    def project
+      @project ||= Project.find_with_namespace(project_slug)
+    rescue => e
+      logger.warn "Project: #{project_slug} record not found."
+    end
+
+    def process!
+      if current_user.blank?
+        logger.warn "Reply user: #{from} not found user in GitLab."
+        return
+      end
+
+      if project.blank?
+        logger.warn "Project #{project_slug} is not found."
+        return
+      end
+
+      note_params = merge_request? ? process_mr! : process_issue!
+      return if note_params.blank?
+
+      note_params[:project_id] = project.id
+      note_params[:note] = body
+
+      @note = Notes::CreateService.new(project, current_user, note_params).execute
+      logger.info "Note #{@note.id} created."
+    end
+
+    def process_mr!
+      @mr = project.merge_requests.find_by(iid: self.issue_id)
+      if @mr.blank?
+        logger.warn "MergeRequest #{self.issue_id} not found."
+        return nil
+      end
+
+      logger.info "Found MergeRequest: #{@mr.id}"
+      { noteable_type: 'MergeRequest', noteable_id: @mr.id }
+    end
+
+    def process_issue!
+      @issue = project.issues.find_by(iid: self.issue_id)
+      if @issue.blank?
+        logger.warn "Issue #{self.issue_id} not found."
+        return nil
+      end
+
+      logger.info "Found issue: #{@issue.id}"
+      { noteable_type: 'Issue', noteable_id: @issue.id }
+    end
+
+    def current_user
+      @current_user ||= User.find_by_any_email(from)
+    end
+
+    private
+
+    def logger
+      @logger ||= Logger.new($stdout)
+    end
+
+    # foo+chair/chair!123 => chair/chair!123
+    def id_prefix
+      return @id_prefix if defined?(@id_prefix)
+      @id_prefix = prefix.split('+').last
+      return @id_prefix
+    end
+  end
+end

data/lib/mail-receiver/reply_to.rb

@@ -0,0 +1,70 @@
+require 'mailman'
+
+module MailReceiver
+  module ReplyTo
+    def mail_new_thread(model, headers = {}, &block)
+      headers['Message-ID'] = message_id(model)
+      headers['X-GitLab-Project'] = "#{@project.name} | " if @project
+
+      # Mail receiver
+      headers[:reply_to] = reply_to_address(model)
+
+      mail(headers, &block)
+    end
+
+    def mail_answer_thread(model, headers = {}, &block)
+      headers['In-Reply-To'] = message_id(model)
+      headers['References'] = message_id(model)
+      headers['X-GitLab-Project'] = "#{@project.name} | " if @project
+
+      if headers[:subject]
+        headers[:subject].prepend('Re: ')
+      end
+
+      # Mail receiver
+      headers[:reply_to] = reply_to_address(model)
+
+      mail(headers, &block)
+    end
+
+    protected
+    def reply_to_address(model)
+      able_path = convert_able_path(model)
+      return default_email_reply_to if able_path.blank?
+      return default_email_reply_to if @project.blank?
+
+      slug = "#{@project.path_with_namespace}#{able_path}"
+
+      Mailman.config.sender.sub('@', "+#{slug}@")
+    end
+
+
+
+    def default_email_reply_to
+      Gitlab.config.gitlab.email_reply_to
+    end
+
+    def convert_able_path(model)
+      if model.class.name == 'Issue'
+        return "##{model.iid}"
+      end
+
+      if model.class.name == 'MergeRequest'
+        return "!#{model.iid}"
+      end
+
+
+      if model.class.name == 'Note'
+        if model.noteable_type == 'Issue' && model.noteable
+          return "##{model.noteable.iid}"
+        end
+
+        if model.noteable_type == 'MergeRequest' && model.noteable
+          return "!#{model.noteable.iid}"
+        end
+      end
+
+      return nil
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: gitlab-mail-receiver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mailman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Allow your GitLab to receive mails to create Issue comment.
+email:
+- huacnlee@gmail.com
+executables:
+- gitlab-mail-receiver
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/gitlab-mail-receiver
+- lib/gitlab-mail-receiver.rb
+- lib/gitlab-mail-receiver/railtie.rb
+- lib/mail-receiver/body_parser.rb
+- lib/mail-receiver/receiver.rb
+- lib/mail-receiver/reply_to.rb
+homepage: http://github.com/huacnlee/gitlab-mail-receiver
+licenses:
+- MIT
+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: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Allow your GitLab to receive mails to create Issue comment
+test_files: []
+has_rdoc: