gitlab-mail-receiver 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ff6d380ad5fe4c2cd3ff4066cfa4c371907a20c
-  data.tar.gz: f3018919650a3ac10e1bc1bbe30a4810430edee8
+  metadata.gz: 685533be718d29db08f1ba52b4b3118a166bc7d8
+  data.tar.gz: 85d33b4ce3c0ddbaaf1118ba95a7a82e211e6210
 SHA512:
-  metadata.gz: 45eaca00bbd532de05c158f898cf3b9e2cfb05d84ad9069b2e18ef661f44b04c884e4d52e02030b9d90356033f751639f765f937e92e59b49bbf554bd3767b93
-  data.tar.gz: 3c186bb6c06e452f6b1c3d2929f145d3053da9ab311ce1440af0460a7e9c8e7644ffe9743a31a5fba1f693438a8030cf441307cb6a6614ad9dd8bf4bb61d9f04
+  metadata.gz: 29173d1720d26e9a9ca378e67c5b6fff0825b51e223093533b56eb56f5298602246ef9f3ecf6d336d9706c787ec17fab90275736ce05d678283e969ce4050390
+  data.tar.gz: a4583f133dd241987ec5cd66b108c567a306c433321d3e027843a4ac497a5e71f4e2bb2e312662ca7b4afe7fb6fde549a7b6ac7beca9774c38610c96a092135e

data/README.md

@@ -1,6 +1,8 @@
 # GitLab Mail Receiver
 
-This gem can allow your GitLab to receive emails to create Issue comments like GitHub.
+[![Gem Version](https://badge.fury.io/rb/gitlab-mail-receiver.svg)](http://badge.fury.io/rb/gitlab-mail-receiver) [![CI Status](https://travis-ci.org/huacnlee/gitlab-mail-receiver.svg)](https://travis-ci.org/huacnlee/gitlab-mail-receiver)
+
+The way of allow your GitLab support Email receive and parse the email content, and find Issue/MergeRequest to create reply.
 
 [中文介绍](https://ruby-china.org/topics/27143)
 
@@ -44,27 +46,52 @@ 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'
+    server: 'imap.your-mail-host.com',
+    port: 993,
+    ssl: true,
+    username: 'xxx@your-mail-host.com',
     password: 'your-password'
   }
 end
 ```
 
-## Run
+## Run commands
 
 ```
 $ cd gitlab
-$ bundle exec gitlab-mail-receiver
+$ bundle exec gitlab-mail-receiver -h
+Commands:
+  gitlab-mail-receiver help [COMMAND]  # Describe available commands or one specific command
+  gitlab-mail-receiver restart         # Restart Daemon
+  gitlab-mail-receiver start           # Start Daemon
+  gitlab-mail-receiver stop            # Stop Daemon
+  gitlab-mail-receiver version         # Show version
+
+Options:
+  [--root=ROOT]
+                 # Default: ./
+$ bundle exec gitlab-mail-receiver start
+Started gitlab-mail-receiver on pid: 59386
+I, [2015-09-01T13:36:50.813124 #59387]  INFO -- : Celluloid 0.17.1.2 is running in BACKPORTED mode. [ http://git.io/vJf3J ]
+...
 ```
 
-> 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 &
+$ RAILS_ENV=production bundle exec gitlab-mail-receiver start -d
+pid_file: ./tmp/pids/gitlab-mail-receiver.pid
+log_file: ./log/gitlab-mail-receiver.log
+Started gitlab-mail-receiver on pid: 58861
+```
+
+> NOTE: The daemon log will write to `$rails_root/log/gitlab-mail-receiver.log`
+
+Stop daemon
+
+```bash
+$ bundle exec gitlab-mail-receiver stop
+Stoping gitlab-mail-receiver... [OK]
+```
 ```

data/bin/gitlab-mail-receiver

@@ -1,26 +1,4 @@
 #!/usr/bin/env ruby
-require 'rubygems'
-require 'bundler/setup'
-require_relative '../lib/gitlab-mail-receiver'
+require_relative '../lib/mail-receiver/cli'
 
-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
+MailReceiver::CLI.start(ARGV)

data/lib/gitlab-mail-receiver.rb

@@ -1,6 +1,8 @@
+require_relative './mail-receiver/encoder'
 require_relative './mail-receiver/body_parser'
 require_relative './mail-receiver/receiver'
 require_relative './mail-receiver/reply_to'
+
 require "mailman"
 require 'active_support/core_ext'
 
@@ -15,6 +17,10 @@ end
 Mailman::Configuration.send(:include, MailmanConfig)
 
 module MailReceiver
+  def self.config
+    Mailman.config
+  end
+
   def self.configure(&block)
     Mailman.config.instance_exec(&block)
   end

data/lib/mail-receiver/cli.rb

@@ -0,0 +1,55 @@
+require_relative './daemon'
+require 'thor'
+
+module MailReceiver
+  class CLI < Thor
+    include Thor::Actions
+
+    map '-v' => :version
+    map "s" => :start
+    class_option :root, type: :string, default: './'
+
+    option :daemon, type: :boolean, aliases: ['d'], default: false
+    desc "start", "Start Daemon"
+    def start
+      MailReceiver::Daemon.init(options) do
+        begin
+          rails_env = ::File.expand_path('./config/environment', options[:root])
+          require rails_env
+        rescue => e
+          puts "You need run this command under GitLab root."
+          return
+        end
+
+        Mailman.config.logger = Logger.new($stdout)
+        Mailman.config.rails_root = options[:root]
+
+        Mailman.config.logger.info "Starting gitlab-mail-receiver..."
+        Mailman::Application.run do
+          to '%user%+%suffix%@%host%' do
+            @receiver = MailReceiver::Receiver.new(message, logger: Mailman.config.logger)
+            @receiver.process!
+          end
+        end
+      end
+      MailReceiver::Daemon.start_process
+    end
+
+    desc "stop", "Stop Daemon"
+    def stop
+      MailReceiver::Daemon.init(options)
+      MailReceiver::Daemon.stop_process
+    end
+
+    desc "restart", "Restart Daemon"
+    def restart
+      MailReceiver::Daemon.init(options)
+      MailReceiver::Daemon.restart_process
+    end
+
+    desc "version", "Show version"
+    def version
+      puts "gitlab-mail-receiver #{MailReceiver.version}"
+    end
+  end
+end

data/lib/mail-receiver/daemon.rb

@@ -0,0 +1,162 @@
+# Daemon code from: https://github.com/huacnlee/sails
+module MailReceiver
+  class Daemon
+    class << self
+      attr_accessor :options, :daemon, :mode, :app_name, :pid_file, :log_file, :runblock
+
+      def init(opts = {}, &block)
+        self.app_name = 'gitlab-mail-receiver'
+        self.pid_file = File.join(opts[:root], "tmp/pids/gitlab-mail-receiver.pid")
+        self.log_file = File.join(opts[:root], 'log/gitlab-mail-receiver.log')
+        self.daemon = opts[:daemon]
+        self.options = opts
+        self.runblock = block
+      end
+
+      def read_pid
+        if !File.exist?(pid_file)
+          return nil
+        end
+
+        pid = File.open(pid_file).read.to_i
+        begin
+          Process.getpgid(pid)
+        rescue
+          pid = nil
+        end
+        pid
+      end
+
+      def start_process
+        old_pid = read_pid
+        if !old_pid.nil?
+          puts colorize("Current have #{app_name} process in running on pid #{old_pid}", :red)
+          return
+        end
+
+        # start master process
+        @master_pid = fork_master_process!
+        File.open(pid_file, "w+") do |f|
+          f.puts @master_pid
+        end
+
+        if self.daemon
+          puts "pid_file: #{self.pid_file}"
+          puts "log_file: #{self.log_file}"
+        end
+        puts "Started #{app_name} on pid: #{@master_pid}"
+        # puts "in init: #{Sails.service.object_id}"
+
+        if not self.daemon
+          Process.waitpid(@master_pid)
+        else
+          exit
+        end
+      end
+
+      def restart_process(options = {})
+        old_pid = read_pid
+        if old_pid == nil
+          puts colorize("#{app_name} process not found on pid #{old_pid}", :red)
+          return
+        end
+
+        print "Restarting #{app_name}..."
+        Process.kill("USR2", old_pid)
+        puts colorize(" [OK]", :green)
+      end
+
+      def fork_master_process!
+        fork do
+          # WARN: DO NOT CALL Sails IN THIS BLOCK!
+          $PROGRAM_NAME = self.app_name + " [master]"
+          @child_pid = fork_child_process!
+
+          Signal.trap("QUIT") do
+            Process.kill("QUIT", @child_pid)
+            exit
+          end
+
+          Signal.trap("USR2") do
+            Process.kill("USR2", @child_pid)
+          end
+
+          loop do
+            sleep 1
+            begin
+              Process.getpgid(@child_pid)
+            rescue Errno::ESRCH
+              @child_pid = fork_child_process!
+            end
+          end
+        end
+      end
+
+      def fork_child_process!
+        pid = fork do
+          $PROGRAM_NAME = self.app_name + " [worker]"
+          Signal.trap("QUIT") do
+            exit
+          end
+
+          Signal.trap("USR2") do
+            # TODO: reload Sails in current process
+            exit
+          end
+
+          if self.daemon == true
+            redirect_stdout
+          end
+
+          # puts "in child: #{Sails.service.object_id}"
+          self.runblock.call
+        end
+        # http://ruby-doc.org/core-1.9.3/Process.html#detach-method
+        Process.detach(pid)
+        pid
+      end
+
+      def stop_process
+        pid = read_pid
+        if pid.nil?
+          puts colorize("#{app_name} process not found, pid #{pid}", :red)
+          return
+        end
+
+        print "Stoping #{app_name}..."
+        begin
+          Process.kill("QUIT", pid)
+        ensure
+          File.delete(pid_file)
+        end
+        puts colorize(" [OK]", :green)
+      end
+
+      private
+      # Redirect stdout, stderr to log file,
+      # If we not do this, stdout will block sails daemon, for example `puts`.
+      def redirect_stdout
+        redirect_io($stdout, self.log_file)
+        redirect_io($stderr, self.log_file)
+      end
+
+      def redirect_io(io, path)
+        File.open(path, 'ab') { |fp| io.reopen(fp) } if path
+        io.sync = true
+      end
+
+      def colorize(text, c)
+        case c
+        when :red
+          return ["\033[31m",text,"\033[0m"].join("")
+        when :green
+          return ["\033[32m",text,"\033[0m"].join("")
+        when :blue
+          return ["\033[34m",text,"\033[0m"].join("")
+        else
+          return text
+        end
+      end
+    end
+  end
+end

data/lib/mail-receiver/encoder.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/hash'
+require 'rack'
+
+module MailReceiver
+  module Encoder
+    class << self
+      def encode(hash)
+        hash.to_query
+      end
+
+      def decode(query)
+       Rack::Utils.parse_query(query).deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/mail-receiver/receiver.rb

@@ -12,15 +12,19 @@ module MailReceiver
     end
 
     def project_slug
-      @project_slug ||= id_prefix.split(/!|#/).first
+      hash_data[:p]
     end
 
     def issue_id
-      @issue_id ||= id_prefix.split(/!|#/).last
+      hash_data[:id]
+    end
+
+    def target_id
+      hash_data[:n]
     end
 
     def merge_request?
-      @merge_request ||= id_prefix.match('!')
+      @merge_request ||= hash_data[:t].downcase == 'm'
     end
 
     def body
@@ -42,14 +46,23 @@ module MailReceiver
       @prefix ||= to.split('@').first
     end
 
+    # foo+p=chair/chair&id=123 => { p: chair/chair, id: 123 }
+    def hash_data
+      return @hash_data if defined?(@hash_data)
+      return {} if not prefix.include?('+')
+      @hash_data = Encoder.decode(prefix.split('+').last)
+      return @hash_data
+    end
+
     def inspect
-      { project_slug: project_slug, issue_id: issue_id, merge_request: merge_request?, to: to, body: body}
+      { project_slug: project_slug, issue_id: issue_id, target_id: target_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."
+      nil
     end
 
     def process!
@@ -67,6 +80,16 @@ module MailReceiver
       return if note_params.blank?
 
       note_params[:project_id] = project.id
+
+      # relation to target Note
+      if target_id
+        target_note = project.notes.find_by_id(target_id)
+        if target_note
+          note_params[:commit_id] = target_note.commit_id
+          note_params[:line_code] = target_note.line_code
+        end
+      end
+
       note_params[:note] = body
 
       @note = Notes::CreateService.new(project, current_user, note_params).execute
@@ -99,17 +122,8 @@ module MailReceiver
       @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

@@ -1,11 +1,9 @@
 require 'mailman'
+require 'json'
 
 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)
 
@@ -13,10 +11,6 @@ module MailReceiver
     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
@@ -29,39 +23,37 @@ module MailReceiver
 
     protected
     def reply_to_address(model)
-      able_path = convert_able_path(model)
-      return default_email_reply_to if able_path.blank?
+      hash = convert_able(model)
+      return default_email_reply_to if hash.blank?
       return default_email_reply_to if @project.blank?
 
-      slug = "#{@project.path_with_namespace}#{able_path}"
 
-      Mailman.config.sender.sub('@', "+#{slug}@")
-    end
+      hash.merge!({ p: @project.path_with_namespace })
 
+      suffix = Encoder.encode(hash)
 
+      Mailman.config.sender.sub('@', "+#{suffix}@")
+    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}"
+    def convert_able(model)
+      res = { id: model.iid }
+      if defined?(@note)
+        # gitlab/app/mailers/emails/notes.rb 里面会声明 @note
+        res.merge!({ n: @note.id })
       end
 
-      if model.class.name == 'MergeRequest'
-        return "!#{model.iid}"
+      if model.class.name == 'Issue'
+        res.merge({ t: 'i' })
+        return res
       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
+      if model.class.name == 'MergeRequest'
+        res.merge({ t: 't' })
+        return res
       end
 
       return nil

data/lib/mail-receiver/version.rb

@@ -0,0 +1,7 @@
+module MailReceiver
+  class << self
+    def version
+      '0.0.2'
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-mail-receiver
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jason Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mailman
@@ -38,7 +38,36 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Allow your GitLab to receive mails to create Issue comment.
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+description: The way of allow your GitLab support Email receive and parse the email
+  content, and find Issue/MergeRequest to create reply.
 email:
 - huacnlee@gmail.com
 executables:
@@ -50,10 +79,13 @@ files:
 - 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/cli.rb
+- lib/mail-receiver/daemon.rb
+- lib/mail-receiver/encoder.rb
 - lib/mail-receiver/receiver.rb
 - lib/mail-receiver/reply_to.rb
+- lib/mail-receiver/version.rb
 homepage: http://github.com/huacnlee/gitlab-mail-receiver
 licenses:
 - MIT
@@ -77,6 +109,6 @@ rubyforge_project:
 rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
-summary: Allow your GitLab to receive mails to create Issue comment
+summary: Allow your GitLab receive mails to create Issue comment
 test_files: []
 has_rdoc: 

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

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