├── .editorconfig
├── .gitignore
├── CHANGELOG.md
├── Gemfile
├── Gemfile.lock
├── LICENSE
├── README.md
├── app
├── controllers
│ ├── mappings_controller.rb
│ └── trello_webhooks_controller.rb
├── helpers
│ ├── mappings_helper.rb
│ └── trello_webhooks_helper.rb
└── views
│ ├── mappings
│ ├── _bidirectional_sync.html.erb
│ ├── edit.html.erb
│ ├── index.html.erb
│ ├── show.html.erb
│ └── update.html.erb
│ ├── projects
│ └── _redmine_trello_card_sync.html.erb
│ ├── settings
│ ├── _trello_sync_settings.html.erb
│ └── _webhook_settings.html.erb
│ ├── trello_webhooks
│ └── index.html.erb
│ └── users
│ └── _redmine_trello_card_sync.html.erb
├── assets
├── images
│ └── trello_card_sync_configuration.png
└── stylesheets
│ ├── style.css
│ └── trello_card_sync.css
├── config
├── locales
│ └── en.yml
└── routes.rb
├── db
└── migrate
│ ├── 001_add_trello_board_id_to_project.rb
│ ├── 002_add_trello_username_to_user.rb
│ ├── 003_add_trello_board_mapping_to_project.rb
│ ├── 004_add_trello_exclude_tracker_from_sync_to_project.rb
│ ├── 005_change_trello_exclude_tracker_default_to_project.rb
│ ├── 006_change_default_trello_exclude_tracker_to_project.rb
│ ├── 007_add_trello_list_mapping_to_project.rb
│ ├── 008_add_trello_excluded_tracker_from_sync_v2_to_project.rb
│ └── 009_add_trello_enable_bidirectional_sync_to_project.rb
├── init.rb
├── lib
├── concerns
│ └── trello_card_sync_project_extension.rb
└── redmine_trello_card_sync
│ ├── hooks.rb
│ ├── patches.rb
│ └── view_hooks.rb
└── test
├── functional
├── mappings_controller_test.rb
└── trello_webhooks_controller_test.rb
└── test_helper.rb
/.editorconfig:
--------------------------------------------------------------------------------
1 | [*]
2 | # Change these settings to your own preference
3 | indent_style = space
4 | indent_size = 2
5 |
6 | # We recommend you to keep these unchanged
7 | end_of_line = lf
8 | charset = utf-8
9 | trim_trailing_whitespace = true
10 | insert_final_newline = true
11 |
12 | [*.md]
13 | trim_trailing_whitespace = false
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # 1.1.3
2 |
3 | * Some minor fixes
4 |
5 | # 1.1.2
6 |
7 | * Some minor fixes
8 |
9 | # 1.1.1
10 |
11 | * Fix Trello Webhooks listing method
12 |
13 | # 1.1.0
14 |
15 | * [experimental] First release which supports bi-directional sync.
16 |
17 | # 1.0.0 -> 1.0.1
18 |
19 | * Fix DB migrations for default value assignment in MySQL text column
20 |
21 | # 0.0.9 -> 1.0.0
22 |
23 | **This is NOT a back compatible release!!! Save your old configurations before you do upgrade!!!**
24 |
25 | * Shinny new, user friendly configuration page.
26 | * Heavily refactored code. (Patches are always welcome!)
27 |
--------------------------------------------------------------------------------
/Gemfile:
--------------------------------------------------------------------------------
1 | source "https://rubygems.org"
2 |
3 | gem 'ruby-trello'
4 |
--------------------------------------------------------------------------------
/Gemfile.lock:
--------------------------------------------------------------------------------
1 | GEM
2 | remote: https://rubygems.org/
3 | specs:
4 | activemodel (7.0.3.1)
5 | activesupport (= 7.0.3.1)
6 | activesupport (7.0.3.1)
7 | concurrent-ruby (~> 1.0, >= 1.0.2)
8 | i18n (>= 1.6, < 2)
9 | minitest (>= 5.1)
10 | tzinfo (~> 2.0)
11 | addressable (2.8.0)
12 | public_suffix (>= 2.0.2, < 5.0)
13 | concurrent-ruby (1.1.10)
14 | domain_name (0.5.20160310)
15 | unf (>= 0.0.5, < 1.0.0)
16 | http-cookie (1.0.2)
17 | domain_name (~> 0.5)
18 | i18n (1.12.0)
19 | concurrent-ruby (~> 1.0)
20 | json (2.3.1)
21 | mime-types (2.99.2)
22 | minitest (5.16.2)
23 | netrc (0.11.0)
24 | oauth (0.4.7)
25 | public_suffix (4.0.6)
26 | rest-client (1.8.0)
27 | http-cookie (>= 1.0.2, < 2.0)
28 | mime-types (>= 1.16, < 3.0)
29 | netrc (~> 0.7)
30 | ruby-trello (1.4.2)
31 | activemodel (>= 3.2.0)
32 | addressable (~> 2.3)
33 | json
34 | oauth (~> 0.4.5)
35 | rest-client (~> 1.8.0)
36 | tzinfo (2.0.5)
37 | concurrent-ruby (~> 1.0)
38 | unf (0.1.4)
39 | unf_ext
40 | unf_ext (0.0.7.2)
41 |
42 | PLATFORMS
43 | ruby
44 |
45 | DEPENDENCIES
46 | ruby-trello
47 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Sync Redmine ticket to Trello card (Moved to [here](https://github.com/hiroshiyui/redmine-trello-card-sync))
2 |
3 | ## Setup
4 |
5 | 1. cd `${YOUR_REDMINE_HOME}/plugins`
6 | 1. `git clone https://github.com/KKBOX/redmine-trello-card-sync.git redmine_trello_card_sync`
7 | 1. Change directory back to your Redmine installation. (`cd ${YOUR_REDMINE_HOME}`)
8 | 1. Run `bundle install --without development test` to install essential gems.
9 | 1. Run `bundle exec rake db:migrate_plugins RAILS_ENV=production` to setup plugin-related database tables. (In older version of Redmine, you may need to run `RAILS_ENV=production bundle exec rake redmine:plugins:migrate` instead)
10 | 1. Go to `http(s)://${YOUR_REDMINE_HOST}/settings/plugin/redmine_trello_card_sync`, enter the essential settings to enable this plugin.
11 | * Get your API key (32 characters long) & member token (64 characters long) from [here](https://trello.com/app-key), note they are *different*, one is the value of "Key", another is what you will get from the "Token" link.
12 | 1. Restart your Redmine server to take effect.
13 |
14 | ## Configuration
15 |
16 | Enable this plugin module in each project's settings -> modules page, such as `http(s)://${YOUR_REDMINE_HOST}/projects/${YOUR_PROJECT}/settings/modules`.
17 |
18 | Once you enable the module, you can configure mappings at `http(s)://${YOUR_REDMINE_HOST}/projects/${YOUR_PROJECT}/trello_card_sync/mappings`.
19 |
20 | You can enter your Trello username at `http(s)://${YOUR_REDMINE_HOST}/my/account`.
21 |
--------------------------------------------------------------------------------
/app/controllers/mappings_controller.rb:
--------------------------------------------------------------------------------
1 | require 'trello'
2 |
3 | # Mappings maintenance
4 | class MappingsController < ApplicationController
5 | unloadable
6 |
7 | before_filter :find_project_by_project_id, :authorize
8 | before_filter :setup_trello_api
9 |
10 | def index
11 | @board_lists = []
12 | if @project.trello_board_id.present?
13 | # "//close" => Our special magic option to close (archive) the card
14 | @extra_close_option = [l(:trello_card_sync_close_option), '//close']
15 | @board_lists = Trello::Board.find(@project.trello_board_id).lists.map { |list| [list.name, list.id] }
16 | @board_lists << @extra_close_option
17 | else
18 | flash[:warning] = t(:trello_card_sync_no_board_specified_warning, project: @project.name)
19 | end
20 | @excluded_trackers = excluded_trackers
21 | @excluded_trackers_v2 = excluded_trackers_v2
22 | @list_mapping = list_mapping
23 | end
24 |
25 | def save
26 | @project.trello_board_id = params[:project][:trello_board_id]
27 | @project.trello_excluded_trackers = params[:project][:trello_excluded_trackers].to_s
28 | @project.trello_excluded_trackers_v2 = params[:project][:trello_excluded_trackers].to_json
29 | @project.trello_list_mapping = params[:trello_list_mapping].to_json
30 | @project.trello_enable_bidirectional_sync = params[:project][:trello_enable_bidirectional_sync].to_i
31 | @project.save!
32 |
33 | # Check & create webhooks
34 | registered_webhook = nil
35 | trello_board_info = ''
36 | if @project.trello_board_id.present?
37 | token = Trello::Token.find( Setting.plugin_redmine_trello_card_sync['member_token'] )
38 | registered_webhook = token.webhooks.find { |whk| whk['idModel'] == @project.trello_board_id }
39 | trello_board_info = "'#{Trello::Board.find( @project.trello_board_id ).name}' (#{@project.trello_board_id})"
40 | end
41 |
42 | # enable
43 | if @project.trello_enable_bidirectional_sync
44 | logger.info('[Trello] Bidirectional sync is enabled')
45 |
46 | if registered_webhook.nil?
47 | # create webhook
48 | logger.info("[Trello] Creating webhook for #{trello_board_info}")
49 | description = "Webhook for #{trello_board_info}"
50 | callback_url = Setting.plugin_redmine_trello_card_sync['webhooks_url']
51 | id_model = @project.trello_board_id
52 | begin
53 | Trello::Webhook.create(description: description, callback_url: callback_url, id_model: id_model)
54 | rescue StandardError => e
55 | error = "[Trello] Oops! Failed to register the webhook: #{e.to_s}"
56 | logger.error(error)
57 | # revert trello_enable_bidirectional_sync
58 | @project.trello_enable_bidirectional_sync = false
59 | @project.save!
60 | flash[:error] = error
61 | end
62 | else
63 | logger.info("[Trello] Webhook has existed for board #{trello_board_info}")
64 | end
65 | # disable
66 | else
67 | logger.info('[Trello] Bidirectional sync is disabled. Check if we have to delete the related Trello webhook.')
68 |
69 | # * Check if there are no more Redmine projects that need bidirectional sync to the Trello board
70 | # * If yes, remove the registered webhook
71 | if registered_webhook
72 | if Project.all.find { |p| p.trello_board_id == @project.trello_board_id && p.trello_enable_bidirectional_sync }
73 | logger.info('[Trello] There is some project that is keep using bidirectional sync, do not un-register webhook.')
74 | else
75 | webhook = Trello::Webhook.find( registered_webhook['id'] )
76 | webhook.delete
77 | logger.info('[Trello] Webhook has been unregistered.')
78 | end
79 | else
80 | logger.info('[Trello] There is no project that has registered a webhook.')
81 | end
82 | end
83 |
84 | redirect_to mappings_url, notice: l(:trello_card_sync_settings_saved)
85 | rescue StandardError => e
86 | logger.error(e.to_s)
87 | redirect_to mappings_url, alert: e.to_s
88 | end
89 |
90 | private
91 |
92 | def excluded_trackers
93 | if @project.trello_excluded_trackers.nil?
94 | # in case someone didn't run migration to give @project.trello_excluded_trackers a default empty array value...
95 | []
96 | else
97 | JSON.parse(@project.trello_excluded_trackers).reject(&:empty?).map(&:to_i)
98 | end
99 | end
100 |
101 | def excluded_trackers_v2
102 | # convert excluded_trackers v1 to v2 if we have nothing but v1
103 | if @project.trello_excluded_trackers.present? && !@project.trello_excluded_trackers_v2.present?
104 | @project.trello_excluded_trackers_v2 = JSON.parse(@project.trello_excluded_trackers).to_json
105 | @project.save!
106 | end
107 |
108 | # if we have neither v1 nor v2...
109 | if @project.trello_excluded_trackers_v2.nil?
110 | []
111 | else
112 | JSON.load(@project.trello_excluded_trackers_v2).reject(&:empty?).map(&:to_i)
113 | end
114 | end
115 |
116 | def list_mapping
117 | list_mapping = {}
118 | if @project.trello_list_mapping.present?
119 | list_mapping = Hash[JSON.load(@project.trello_list_mapping).map { |k, v| [k.to_i, v.to_s] }]
120 | end
121 | list_mapping
122 | end
123 |
124 | def setup_trello_api
125 | Trello.configure do |config|
126 | config.developer_public_key = Setting.plugin_redmine_trello_card_sync['public_key'].present? ? Setting.plugin_redmine_trello_card_sync['public_key'].strip : ''
127 | config.member_token = Setting.plugin_redmine_trello_card_sync['member_token'].present? ? Setting.plugin_redmine_trello_card_sync['member_token'].strip : ''
128 | end
129 | end
130 | end
131 |
--------------------------------------------------------------------------------
/app/controllers/trello_webhooks_controller.rb:
--------------------------------------------------------------------------------
1 | require 'openssl'
2 | require 'base64'
3 |
4 | # Trello webhooks (Sync from Trello to Redmine)
5 | class TrelloWebhooksController < ApplicationController
6 | unloadable
7 | skip_before_action :check_if_login_required
8 | skip_before_action :authenticate
9 | skip_before_action :verify_authenticity_token
10 |
11 | def index
12 | render status: 200, json: { status: 'ok' }
13 | end
14 |
15 | def update_redmine_issue
16 | @webhooks_request = TrelloWebhooksHelper::WebhooksRequest.new(request)
17 | logger.info("[Trello] Webhook payload: #{@webhooks_request.payload}")
18 |
19 | unless @webhooks_request.valid_request?
20 | logger.info('[Trello] Mismatched signature, maybe a fake reqest or you have a wrong API secret.')
21 | render(status: 403, json: { status: 'error', message: 'Mismatched signature, maybe a fake reqest.' }) && (return true)
22 | end
23 |
24 | if @webhooks_request.payload['action']['type'] == 'updateCard'
25 | issue_data = /^\#(?\d+)\s(?.*)/.match(@webhooks_request.payload['action']['data']['card']['name'])
26 | issue = Issue.find(issue_data[:issue_number])
27 |
28 | if issue.nil?
29 | render(status: 500, json: { status: 'error', message: 'Unable to find the Redmine issue.' }) && (return true)
30 | end
31 |
32 | # reversal sync: card.name -> issue.subject
33 | if @webhooks_request.payload['action']['data']['old']['name']
34 | # avoids potential circular update
35 | if issue.subject != issue_data[:issue_subject]
36 | issue.subject = issue_data[:issue_subject]
37 | end
38 | end
39 |
40 | # reversal sync: card.desc -> issue.description
41 | if @webhooks_request.payload['action']['data']['old']['desc']
42 | new_desc = @webhooks_request.payload['action']['data']['card']['desc']
43 | issue.description = new_desc if issue.description != new_desc
44 | end
45 |
46 | # reversal sync: card.due -> issue.due_date
47 | if @webhooks_request.payload['action']['data']['old']['due']
48 | new_due = @webhooks_request.payload['action']['data']['card']['due']
49 | issue.due_date = Date.parse(new_due) if issue.due_date != new_due
50 | end
51 |
52 | # reversal sync: card.move_to_list(idList) -> issue.status.id
53 | if @webhooks_request.payload['action']['data']['old']['idList']
54 | list_mapping = Hash[JSON.load(issue.project.trello_list_mapping).map { |k, v| [k.to_i, v.to_s] }]
55 | new_list_id = @webhooks_request.payload['action']['data']['card']['idList']
56 | new_stat_id = list_mapping.select { |_k, v| v == new_list_id }.keys.first
57 | if new_stat_id.present? && issue.status_id != new_stat_id
58 | issue.status_id = new_stat_id
59 | end
60 | end
61 |
62 | logger.info("[Trello] Saving issue #{issue.id}...")
63 | issue.save!
64 | end
65 |
66 | render status: 200, json: { status: 'ok' }
67 | end
68 | end
69 |
--------------------------------------------------------------------------------
/app/helpers/mappings_helper.rb:
--------------------------------------------------------------------------------
1 | module MappingsHelper
2 | end
3 |
--------------------------------------------------------------------------------
/app/helpers/trello_webhooks_helper.rb:
--------------------------------------------------------------------------------
1 | module TrelloWebhooksHelper
2 | class WebhooksRequest
3 | attr_accessor :payload, :raw_payload, :signature, :digest
4 | def initialize(request)
5 | @raw_payload = request.raw_post
6 | @payload = JSON.parse(request.raw_post)
7 | @original_url = request.original_url
8 | @signature = request.headers['X-Trello-Webhook']
9 | end
10 |
11 | def digest
12 | signature_base64_digest(@raw_payload + @original_url).strip
13 | end
14 |
15 | def valid_request?
16 | @signature_base64_digest == @digest
17 | end
18 |
19 | private
20 |
21 | def signature_base64_digest(data)
22 | # ref: https://developers.trello.com/v1.0/page/webhooks#section-webhook-signatures
23 | trello_api_secret = Setting.plugin_redmine_trello_card_sync['api_secret'].present? ? Setting.plugin_redmine_trello_card_sync['api_secret'].strip : ''
24 | Base64.encode64(OpenSSL::HMAC.digest('sha1', trello_api_secret, data))
25 | end
26 | end
27 |
28 | def self.list_webhooks
29 | Trello.configure do |config|
30 | config.developer_public_key = Setting.plugin_redmine_trello_card_sync['public_key'].present? ? Setting.plugin_redmine_trello_card_sync['public_key'].strip : ''
31 | config.member_token = Setting.plugin_redmine_trello_card_sync['member_token'].present? ? Setting.plugin_redmine_trello_card_sync['member_token'].strip : ''
32 | end
33 |
34 | begin
35 | token = Trello::Token.find( Setting.plugin_redmine_trello_card_sync['member_token'] )
36 | rescue
37 | token = nil
38 | end
39 |
40 | if token.nil?
41 | []
42 | else
43 | token.webhooks
44 | end
45 | end
46 | end
47 |
--------------------------------------------------------------------------------
/app/views/mappings/_bidirectional_sync.html.erb:
--------------------------------------------------------------------------------
1 | <% if Setting.plugin_redmine_trello_card_sync['api_secret'].present? && Setting.plugin_redmine_trello_card_sync['webhooks_url'].present? %>
2 |
3 |