jro_apps/redmine Files · extra/mail_handler/rdm-mailhandler.rb

r18596@gaspard (orig r1860): nbc | 2008-09-14 21:03:46 +0200...

r18596@gaspard (orig r1860): nbc | 2008-09-14 21:03:46 +0200 bugfix r18597@gaspard (orig r1861): winterheart | 2008-09-15 17:14:34 +0200 #1902, translation for zh-tw r18598@gaspard (orig r1862): winterheart | 2008-09-15 17:16:53 +0200 #1907, translation for zh r18599@gaspard (orig r1863): winterheart | 2008-09-15 17:19:51 +0200 fixed #1905, patch for Hungarian language r18600@gaspard (orig r1864): winterheart | 2008-09-15 17:22:53 +0200 Minor typo, fixed #1897, thank Denis Tomashenko for reporting. r18601@gaspard (orig r1865): winterheart | 2008-09-15 18:07:30 +0200 Catalan translation (#1822), thanks to Joan Duran for contribuition. Some strings has wrong quoting, I fixed that. r18602@gaspard (orig r1866): nbc | 2008-09-15 21:37:43 +0200 * reposman can create git repository with "--scm git" option * light refactoring r18603@gaspard (orig r1867): jplang | 2008-09-16 23:54:53 +0200 Use RDoc.usage r18604@gaspard (orig r1868): jplang | 2008-09-16 23:56:02 +0200 mailhandler: fixes exit status and adds an explicit message if response code is 403. r18605@gaspard (orig r1869): winterheart | 2008-09-17 17:31:35 +0200 Patch #1909, updates for ru.yml r18606@gaspard (orig r1870): jplang | 2008-09-17 18:39:23 +0200 Render the commit changes list as a tree (#1896). r18607@gaspard (orig r1871): jplang | 2008-09-17 18:48:04 +0200 Fixed: http links containing parentheses fail to reder correctly (#1591). Patch by Paul Rivier. r18608@gaspard (orig r1872): jplang | 2008-09-17 19:18:05 +0200 Removes unused image references in stylesheets (#1914). r18609@gaspard (orig r1873): jplang | 2008-09-17 19:23:08 +0200 Fixed custom query sidebar links broken by r1797 (#1899). git-svn-id: http://redmine.rubyforge.org/svn/branches/nbc@1874 e93f8b46-1217-0410-a6f0-8f06a7374b81

Nicolas Chuche - - Load All Authors

File last commit:

r1872:54433282d3e7


                r1872:54433282d3e7

Download file

             rdm-mailhandler.rb
        
                    129 lines
            
             | 4.1 KiB
            
                | text/x-ruby
            
             |
                RubyLexer
            
             / extra / mail_handler / rdm-mailhandler.rb
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
      #!/usr/bin/ruby

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
      # == Synopsis

      #

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
      # Reads an email from standard input and forward it to a Redmine server

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
      # through a HTTP request.

      #

      # == Usage

      #

      #    rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>

      #

      # == Arguments

      # 

      #   -u, --url                      URL of the Redmine server

      #   -k, --key                      Redmine API key

      #   

      # General options:

      #   -h, --help                     show this help

      #   -v, --verbose                  show extra information

      #   -V, --version                  show version information and exit

      # 

      # Issue attributes control options:

      #   -p, --project=PROJECT          identifier of the target project

      #   -t, --tracker=TRACKER          name of the target tracker

      #       --category=CATEGORY        name of the target category

      #       --priority=PRIORITY        name of the target priority

      #   -o, --allow-override=ATTRS     allow email content to override attributes

      #                                  specified by previous options

      #                                  ATTRS is a comma separated list of attributes

      #       

      # == Examples

      # No project specified. Emails MUST contain the 'Project' keyword:

      # 

      #   rdm-mailhandler --url http://redmine.domain.foo --key secret

      #   

      # Fixed project and default tracker specified, but emails can override

      # both tracker and priority attributes using keywords:

      # 

      #   rdm-mailhandler --url https://domain.foo/redmine --key secret \\

      #                   --project foo \\

      #                   --tracker bug \\

      #                   --allow-override tracker,priority

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
      require 'net/http'

      require 'net/https'

      require 'uri'

      require 'getoptlong'

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
      require 'rdoc/usage'

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
        Jean-Philippe Lang
    
Fixes rdm-mailhandler SSL support (#1724)....

              r1714
            
      module Net

        class HTTPS < HTTP

          def self.post_form(url, params)

            request = Post.new(url.path)

            request.form_data = params

            request.basic_auth url.user, url.password if url.user

            http = new(url.host, url.port)

            http.use_ssl = (url.scheme == 'https')

            http.start {|h| h.request(request) }

          end

        end

      end

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
      class RedmineMailHandler

        VERSION = '0.1'

        Jean-Philippe Lang
    
Mail handler: more control over issue attributes (#1110)....

              r1629
            
        attr_accessor :verbose, :issue_attributes, :allow_override, :url, :key

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
        def initialize

        Jean-Philippe Lang
    
Mail handler: more control over issue attributes (#1110)....

              r1629
            
          self.issue_attributes = {}

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
          opts = GetoptLong.new(

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
            [ '--help',           '-h', GetoptLong::NO_ARGUMENT ],

            [ '--version',        '-V', GetoptLong::NO_ARGUMENT ],

            [ '--verbose',        '-v', GetoptLong::NO_ARGUMENT ],

            [ '--url',            '-u', GetoptLong::REQUIRED_ARGUMENT ],

            [ '--key',            '-k', GetoptLong::REQUIRED_ARGUMENT],

            [ '--project',        '-p', GetoptLong::REQUIRED_ARGUMENT ],

            [ '--tracker',        '-t', GetoptLong::REQUIRED_ARGUMENT],

            [ '--category',             GetoptLong::REQUIRED_ARGUMENT],

            [ '--priority',             GetoptLong::REQUIRED_ARGUMENT],

        Jean-Philippe Lang
    
Mail handler: more control over issue attributes (#1110)....

              r1629
            
            [ '--allow-override', '-o', GetoptLong::REQUIRED_ARGUMENT]

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
          )

          opts.each do |opt, arg|

            case opt

            when '--url'

              self.url = arg.dup

            when '--key'

              self.key = arg.dup

            when '--help'

              usage

            when '--verbose'

              self.verbose = true

            when '--version'

              puts VERSION; exit

        Jean-Philippe Lang
    
Mail handler: more control over issue attributes (#1110)....

              r1629
            
            when '--project', '--tracker', '--category', '--priority'

              self.issue_attributes[opt.gsub(%r{^\-\-}, '')] = arg.dup

            when '--allow-override'

              self.allow_override = arg.dup

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
            end

          end

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
          RDoc.usage if url.nil?

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
        end

        def submit(email)

          uri = url.gsub(%r{/*$}, '') + '/mail_handler'

        Jean-Philippe Lang
    
Mail handler: more control over issue attributes (#1110)....

              r1629
            
          data = { 'key' => key, 'email' => email, 'allow_override' => allow_override }

          issue_attributes.each { |attr, value| data["issue[#{attr}]"] = value }

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
          debug "Posting to #{uri}..."

        Jean-Philippe Lang
    
Fixes rdm-mailhandler SSL support (#1724)....

              r1714
            
          response = Net::HTTPS.post_form(URI.parse(uri), data)

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
          debug "Response received: #{response.code}"

        Nicolas Chuche
    
 r18596@gaspard (orig r1860):  nbc | 2008-09-14 21:03:46 +0200...

              r1872
            
          puts "Request was denied by your Redmine server. " + 

               "Please, make sure that 'WS for incoming emails' is enabled in application settings and that you provided the correct API key." if response.code == '403'

          response.code == '201' ? 0 : 1

        Jean-Philippe Lang
    
Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....

              r1570
            
        end

        private

        def debug(msg)

          puts msg if verbose

        end

      end

      handler = RedmineMailHandler.new

      handler.submit(STDIN.read)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	#!/usr/bin/ruby

Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872	# == Synopsis
		#
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	# Reads an email from standard input and forward it to a Redmine server
Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872	# through a HTTP request.
		#
		# == Usage
		#
		# rdm-mailhandler [options] --url=<Redmine URL> --key=<API key>
		#
		# == Arguments
		#
		# -u, --url URL of the Redmine server
		# -k, --key Redmine API key
		#
		# General options:
		# -h, --help show this help
		# -v, --verbose show extra information
		# -V, --version show version information and exit
		#
		# Issue attributes control options:
		# -p, --project=PROJECT identifier of the target project
		# -t, --tracker=TRACKER name of the target tracker
		# --category=CATEGORY name of the target category
		# --priority=PRIORITY name of the target priority
		# -o, --allow-override=ATTRS allow email content to override attributes
		# specified by previous options
		# ATTRS is a comma separated list of attributes
		#
		# == Examples
		# No project specified. Emails MUST contain the 'Project' keyword:
		#
		# rdm-mailhandler --url http://redmine.domain.foo --key secret
		#
		# Fixed project and default tracker specified, but emails can override
		# both tracker and priority attributes using keywords:
		#
		# rdm-mailhandler --url https://domain.foo/redmine --key secret \\
		# --project foo \\
		# --tracker bug \\
		# --allow-override tracker,priority
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570
		require 'net/http'
		require 'net/https'
		require 'uri'
		require 'getoptlong'
Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872	require 'rdoc/usage'
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570
Jean-Philippe Lang Fixes rdm-mailhandler SSL support (#1724)....	r1714	module Net
		class HTTPS < HTTP
		def self.post_form(url, params)
		request = Post.new(url.path)
		request.form_data = params
		request.basic_auth url.user, url.password if url.user
		http = new(url.host, url.port)
		http.use_ssl = (url.scheme == 'https')
		http.start {\|h\| h.request(request) }
		end
		end
		end

Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	class RedmineMailHandler
		VERSION = '0.1'

Jean-Philippe Lang Mail handler: more control over issue attributes (#1110)....	r1629	attr_accessor :verbose, :issue_attributes, :allow_override, :url, :key
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570
		def initialize
Jean-Philippe Lang Mail handler: more control over issue attributes (#1110)....	r1629	self.issue_attributes = {}

Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	opts = GetoptLong.new(
Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872	[ '--help', '-h', GetoptLong::NO_ARGUMENT ],
		[ '--version', '-V', GetoptLong::NO_ARGUMENT ],
		[ '--verbose', '-v', GetoptLong::NO_ARGUMENT ],
		[ '--url', '-u', GetoptLong::REQUIRED_ARGUMENT ],
		[ '--key', '-k', GetoptLong::REQUIRED_ARGUMENT],
		[ '--project', '-p', GetoptLong::REQUIRED_ARGUMENT ],
		[ '--tracker', '-t', GetoptLong::REQUIRED_ARGUMENT],
		[ '--category', GetoptLong::REQUIRED_ARGUMENT],
		[ '--priority', GetoptLong::REQUIRED_ARGUMENT],
Jean-Philippe Lang Mail handler: more control over issue attributes (#1110)....	r1629	[ '--allow-override', '-o', GetoptLong::REQUIRED_ARGUMENT]
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	)

		opts.each do \|opt, arg\|
		case opt
		when '--url'
		self.url = arg.dup
		when '--key'
		self.key = arg.dup
		when '--help'
		usage
		when '--verbose'
		self.verbose = true
		when '--version'
		puts VERSION; exit
Jean-Philippe Lang Mail handler: more control over issue attributes (#1110)....	r1629	when '--project', '--tracker', '--category', '--priority'
		self.issue_attributes[opt.gsub(%r{^\-\-}, '')] = arg.dup
		when '--allow-override'
		self.allow_override = arg.dup
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	end
		end

Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872	RDoc.usage if url.nil?
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	end

		def submit(email)
		uri = url.gsub(%r{/*$}, '') + '/mail_handler'
Jean-Philippe Lang Mail handler: more control over issue attributes (#1110)....	r1629
		data = { 'key' => key, 'email' => email, 'allow_override' => allow_override }
		issue_attributes.each { \|attr, value\| data["issue[#{attr}]"] = value }

Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	debug "Posting to #{uri}..."
Jean-Philippe Lang Fixes rdm-mailhandler SSL support (#1724)....	r1714	response = Net::HTTPS.post_form(URI.parse(uri), data)
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	debug "Response received: #{response.code}"
Nicolas Chuche r18596@gaspard (orig r1860): nbc \| 2008-09-14 21:03:46 +0200...	r1872
		puts "Request was denied by your Redmine server. " +
		"Please, make sure that 'WS for incoming emails' is enabled in application settings and that you provided the correct API key." if response.code == '403'
		response.code == '201' ? 0 : 1
Jean-Philippe Lang Adds a simple API and a standalone script that can be used to forward emails from a local or remote email server to Redmine (#1110)....	r1570	end

		private

		def debug(msg)
		puts msg if verbose
		end
		end

		handler = RedmineMailHandler.new
		handler.submit(STDIN.read)