ruby-trello 2.2.0 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (314) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -10
  3. data/lib/trello/action.rb +31 -23
  4. data/lib/trello/association_builder/has_many.rb +17 -0
  5. data/lib/trello/association_builder/has_one.rb +16 -0
  6. data/lib/trello/association_fetcher/has_many/fetch.rb +47 -0
  7. data/lib/trello/association_fetcher/has_many/params.rb +56 -0
  8. data/lib/trello/association_fetcher/has_many.rb +26 -0
  9. data/lib/trello/association_fetcher/has_one/fetch.rb +49 -0
  10. data/lib/trello/association_fetcher/has_one/params.rb +36 -0
  11. data/lib/trello/association_fetcher/has_one.rb +25 -0
  12. data/lib/trello/association_infer_tool.rb +13 -0
  13. data/lib/trello/association_proxy.rb +1 -1
  14. data/lib/trello/attachment.rb +40 -27
  15. data/lib/trello/basic_data.rb +103 -49
  16. data/lib/trello/board.rb +88 -102
  17. data/lib/trello/card.rb +49 -198
  18. data/lib/trello/checklist.rb +17 -71
  19. data/lib/trello/comment.rb +39 -26
  20. data/lib/trello/cover_image.rb +20 -0
  21. data/lib/trello/custom_field.rb +31 -67
  22. data/lib/trello/custom_field_item.rb +37 -39
  23. data/lib/trello/custom_field_option.rb +40 -13
  24. data/lib/trello/item.rb +27 -16
  25. data/lib/trello/item_state.rb +7 -15
  26. data/lib/trello/json_utils.rb +1 -1
  27. data/lib/trello/label.rb +15 -85
  28. data/lib/trello/label_name.rb +22 -25
  29. data/lib/trello/list.rb +31 -44
  30. data/lib/trello/member.rb +77 -32
  31. data/lib/trello/notification.rb +27 -20
  32. data/lib/trello/organization.rb +53 -25
  33. data/lib/trello/plugin_datum.rb +11 -16
  34. data/lib/trello/schema/attribute/base.rb +79 -0
  35. data/lib/trello/schema/attribute/board_pref.rb +45 -0
  36. data/lib/trello/schema/attribute/custom_field_display.rb +45 -0
  37. data/lib/trello/schema/attribute/default.rb +45 -0
  38. data/lib/trello/schema/attribute_builder.rb +42 -0
  39. data/lib/trello/schema/attribute_registration.rb +47 -0
  40. data/lib/trello/schema/serializer/default.rb +17 -0
  41. data/lib/trello/schema/serializer/labels.rb +23 -0
  42. data/lib/trello/schema/serializer/time.rb +25 -0
  43. data/lib/trello/schema/serializer/webhooks.rb +25 -0
  44. data/lib/trello/schema.rb +31 -0
  45. data/lib/trello/token.rb +15 -12
  46. data/lib/trello/webhook.rb +18 -71
  47. data/lib/trello.rb +57 -39
  48. data/spec/action_spec.rb +2 -3
  49. data/spec/board_spec.rb +43 -103
  50. data/spec/card_spec.rb +143 -66
  51. data/spec/cassettes/action_find_with_id_and_get_all_fields.yml +104 -0
  52. data/spec/cassettes/board_find_with_id_and_get_all_fields.yml +96 -0
  53. data/spec/cassettes/board_find_with_id_and_get_specific_fields.yml +96 -0
  54. data/spec/cassettes/can_add_a_file_from_url_on_a_card.yml +189 -0
  55. data/spec/cassettes/can_add_a_file_on_a_card.yml +200 -0
  56. data/spec/cassettes/can_add_a_member_to_a_board.yml +191 -0
  57. data/spec/cassettes/can_add_a_member_to_a_card.yml +190 -0
  58. data/spec/cassettes/can_add_label_on_a_card.yml +281 -0
  59. data/spec/cassettes/can_arvhice_all_cards_of_list.yml +397 -0
  60. data/spec/cassettes/can_close_bong_a_card.yml +189 -0
  61. data/spec/cassettes/can_get_actions.yml +196 -0
  62. data/spec/cassettes/can_get_actions_of_board.yml +188 -0
  63. data/spec/cassettes/can_get_actions_of_list.yml +202 -0
  64. data/spec/cassettes/can_get_actions_of_members.yml +199 -0
  65. data/spec/cassettes/can_get_actions_of_organization.yml +201 -0
  66. data/spec/cassettes/can_get_attachments.yml +187 -0
  67. data/spec/cassettes/can_get_boards_of_custom_field.yml +198 -0
  68. data/spec/cassettes/can_get_boards_of_label.yml +197 -0
  69. data/spec/cassettes/can_get_boards_of_organization.yml +207 -0
  70. data/spec/cassettes/can_get_cards_of_board.yml +193 -0
  71. data/spec/cassettes/can_get_cards_of_list.yml +201 -0
  72. data/spec/cassettes/can_get_cards_of_member.yml +204 -0
  73. data/spec/cassettes/can_get_checklists_of_board.yml +187 -0
  74. data/spec/cassettes/can_get_comments.yml +193 -0
  75. data/spec/cassettes/can_get_comments_board.yml +109 -0
  76. data/spec/cassettes/can_get_comments_card.yml +111 -0
  77. data/spec/cassettes/can_get_comments_list.yml +109 -0
  78. data/spec/cassettes/can_get_custom_field_options_of_custom_field.yml +197 -0
  79. data/spec/cassettes/can_get_custom_fields_of_board.yml +187 -0
  80. data/spec/cassettes/can_get_label_names_of_board.yml +187 -0
  81. data/spec/cassettes/can_get_labels_of_board.yml +187 -0
  82. data/spec/cassettes/can_get_lists_of_board.yml +187 -0
  83. data/spec/cassettes/can_get_members_of_board.yml +188 -0
  84. data/spec/cassettes/can_get_members_of_organization.yml +200 -0
  85. data/spec/cassettes/can_get_notifications_of_member.yml +199 -0
  86. data/spec/cassettes/can_get_organization_of_board.yml +189 -0
  87. data/spec/cassettes/can_get_organizations_of_member.yml +203 -0
  88. data/spec/cassettes/can_get_plugin_data_of_board.yml +187 -0
  89. data/spec/cassettes/can_move_a_card_to_another_board_with_specific_list.yml +373 -0
  90. data/spec/cassettes/can_move_a_card_to_another_board_without_specific_list.yml +281 -0
  91. data/spec/cassettes/can_move_a_card_to_another_list.yml +281 -0
  92. data/spec/cassettes/can_move_all_cards_to_another_list.yml +886 -0
  93. data/spec/cassettes/can_remove_a_member_from_a_card.yml +185 -0
  94. data/spec/cassettes/can_remove_an_attachment_on_a_card.yml +277 -0
  95. data/spec/cassettes/can_remove_an_upvote_on_a_card.yml +465 -0
  96. data/spec/cassettes/can_remove_label_on_a_card.yml +279 -0
  97. data/spec/cassettes/can_success_add_comment_to_a_card.yml +196 -0
  98. data/spec/cassettes/can_success_copy_checklist_to_a_card.yml +281 -0
  99. data/spec/cassettes/can_success_copy_checklist_to_a_card_without_name_pos.yml +281 -0
  100. data/spec/cassettes/can_success_create_a_board.yml +98 -0
  101. data/spec/cassettes/can_success_create_a_board_with_full_parameters.yml +97 -0
  102. data/spec/cassettes/can_success_create_a_board_without_clone_from_other.yml +98 -0
  103. data/spec/cassettes/can_success_create_a_card.yml +99 -0
  104. data/spec/cassettes/can_success_create_a_card_when_due_is_datetime.yml +98 -0
  105. data/spec/cassettes/can_success_create_a_card_when_due_is_time.yml +98 -0
  106. data/spec/cassettes/can_success_create_a_checklist.yml +102 -0
  107. data/spec/cassettes/can_success_create_a_custom_field.yml +102 -0
  108. data/spec/cassettes/can_success_create_a_custom_field_option.yml +102 -0
  109. data/spec/cassettes/can_success_create_a_label.yml +102 -0
  110. data/spec/cassettes/can_success_create_a_list.yml +102 -0
  111. data/spec/cassettes/can_success_create_a_list_with_full_parameters.yml +102 -0
  112. data/spec/cassettes/can_success_create_a_organization.yml +104 -0
  113. data/spec/cassettes/can_success_create_a_webhook.yml +102 -0
  114. data/spec/cassettes/can_success_create_new_checklist_to_a_card.yml +189 -0
  115. data/spec/cassettes/can_success_delete_a_custom_field_option.yml +389 -0
  116. data/spec/cassettes/can_success_delete_card.yml +185 -0
  117. data/spec/cassettes/can_success_delete_checklist.yml +284 -0
  118. data/spec/cassettes/can_success_get_card_of_board_by_card_id.yml +188 -0
  119. data/spec/cassettes/can_success_remove_member_from_board.yml +186 -0
  120. data/spec/cassettes/can_success_return_all_boards_of_current_user.yml +195 -0
  121. data/spec/cassettes/can_success_upate_a_board.yml +191 -0
  122. data/spec/cassettes/can_success_upate_a_card.yml +189 -0
  123. data/spec/cassettes/can_success_upate_a_list.yml +296 -0
  124. data/spec/cassettes/can_success_update_bong_a_board.yml +283 -0
  125. data/spec/cassettes/can_success_update_bong_a_board_with_specific_fields.yml +284 -0
  126. data/spec/cassettes/can_success_update_bong_a_card.yml +191 -0
  127. data/spec/cassettes/can_success_update_bong_a_checklist_with_specific_fields.yml +296 -0
  128. data/spec/cassettes/can_success_update_bong_a_custom_field.yml +200 -0
  129. data/spec/cassettes/can_success_update_bong_a_label.yml +200 -0
  130. data/spec/cassettes/can_success_update_bong_a_list.yml +199 -0
  131. data/spec/cassettes/can_success_update_bong_a_list_with_specific_fields.yml +296 -0
  132. data/spec/cassettes/can_success_update_bong_a_organization.yml +203 -0
  133. data/spec/cassettes/can_success_update_bong_a_webhook.yml +296 -0
  134. data/spec/cassettes/can_upvote_on_a_card.yml +469 -0
  135. data/spec/cassettes/card_find_with_id_and_get_all_fields.yml +95 -0
  136. data/spec/cassettes/card_find_with_id_and_get_specific_fields.yml +96 -0
  137. data/spec/cassettes/checklist_can_add_an_item.yml +296 -0
  138. data/spec/cassettes/checklist_can_update_the_item_state.yml +296 -0
  139. data/spec/cassettes/checklist_find_with_id_and_get_all_fields.yml +100 -0
  140. data/spec/cassettes/comment_delete.yml +331 -0
  141. data/spec/cassettes/comment_find_with_id.yml +116 -0
  142. data/spec/cassettes/custom_field_find_with_id_and_get_all_fields.yml +100 -0
  143. data/spec/cassettes/custom_field_find_with_id_and_get_specific_fields.yml +100 -0
  144. data/spec/cassettes/custom_field_item_save_1.yml +97 -0
  145. data/spec/cassettes/custom_field_item_save_2.yml +281 -0
  146. data/spec/cassettes/custom_field_option_find_with_id.yml +100 -0
  147. data/spec/cassettes/get_board_of_card.yml +187 -0
  148. data/spec/cassettes/get_board_of_list.yml +197 -0
  149. data/spec/cassettes/get_boards_of_member.yml +207 -0
  150. data/spec/cassettes/get_check_item_states_of_card.yml +188 -0
  151. data/spec/cassettes/get_checklists_of_card.yml +187 -0
  152. data/spec/cassettes/get_cover_image_of_card.yml +187 -0
  153. data/spec/cassettes/get_custom_field_items_of_card.yml +187 -0
  154. data/spec/cassettes/get_list_of_card.yml +188 -0
  155. data/spec/cassettes/get_lists.yml +187 -0
  156. data/spec/cassettes/get_members_of_card.yml +189 -0
  157. data/spec/cassettes/get_plugin_data_of_card.yml +187 -0
  158. data/spec/cassettes/get_voters_of_card.yml +188 -0
  159. data/spec/cassettes/label_delete.yml +285 -0
  160. data/spec/cassettes/label_find_with_id.yml +100 -0
  161. data/spec/cassettes/list_find_with_id_and_get_all_fields.yml +100 -0
  162. data/spec/cassettes/list_find_with_id_and_get_specific_fields.yml +100 -0
  163. data/spec/cassettes/member_find_with_id_and_get_all_fields.yml +101 -0
  164. data/spec/cassettes/member_find_with_id_and_get_specific_fields.yml +100 -0
  165. data/spec/cassettes/notification_find_with_id.yml +103 -0
  166. data/spec/cassettes/organization_find_with_id_and_get_all_fields.yml +102 -0
  167. data/spec/cassettes/organization_find_with_id_and_get_specific_fields.yml +100 -0
  168. data/spec/cassettes/remove_upvote_on_a_card_when_have_not_voted.yml +366 -0
  169. data/spec/cassettes/revote_on_a_card.yml +464 -0
  170. data/spec/cassettes/token_find_with_token_string.yml +100 -0
  171. data/spec/cassettes/webhook_delete.yml +286 -0
  172. data/spec/cassettes/webhook_find_with_id.yml +100 -0
  173. data/spec/checklist_spec.rb +27 -43
  174. data/spec/custom_field_item_spec.rb +74 -0
  175. data/spec/custom_field_option_spec.rb +2 -2
  176. data/spec/custom_field_spec.rb +98 -10
  177. data/spec/integration/action/find_spec.rb +23 -0
  178. data/spec/integration/basic_data/many_spec.rb +127 -0
  179. data/spec/integration/basic_data/one_spec.rb +84 -0
  180. data/spec/integration/basic_data/schema_spec.rb +156 -0
  181. data/spec/integration/board/add_member_spec.rb +21 -0
  182. data/spec/integration/board/all_spec.rb +20 -0
  183. data/spec/integration/board/associations/actions_spec.rb +18 -0
  184. data/spec/integration/board/associations/cards_spec.rb +18 -0
  185. data/spec/integration/board/associations/checklists_spec.rb +18 -0
  186. data/spec/integration/board/associations/custom_fields_spec.rb +18 -0
  187. data/spec/integration/board/associations/label_names_spec.rb +17 -0
  188. data/spec/integration/board/associations/labels_spec.rb +18 -0
  189. data/spec/integration/board/associations/lists_spec.rb +18 -0
  190. data/spec/integration/board/associations/members_spec.rb +18 -0
  191. data/spec/integration/board/associations/organization_spec.rb +19 -0
  192. data/spec/integration/board/associations/plugin_data_spec.rb +18 -0
  193. data/spec/integration/board/create_spec.rb +95 -0
  194. data/spec/integration/board/find_card_spec.rb +18 -0
  195. data/spec/integration/board/find_spec.rb +42 -0
  196. data/spec/integration/board/remove_member_spec.rb +21 -0
  197. data/spec/integration/board/save_spec.rb +37 -0
  198. data/spec/integration/board/update!_spec.rb +62 -0
  199. data/spec/integration/board_lists_spec.rb +21 -0
  200. data/spec/integration/card/add_and_remove_attachment_spec.rb +45 -0
  201. data/spec/integration/card/add_and_remove_label_spec.rb +35 -0
  202. data/spec/integration/card/add_checklist_spec.rb +32 -0
  203. data/spec/integration/card/add_comment_spec.rb +19 -0
  204. data/spec/integration/card/add_memeber_spec.rb +19 -0
  205. data/spec/integration/card/associations/actions_spec.rb +17 -0
  206. data/spec/integration/card/associations/attachments_spec.rb +18 -0
  207. data/spec/integration/card/associations/board_spec.rb +17 -0
  208. data/spec/integration/card/associations/check_item_states_spec.rb +17 -0
  209. data/spec/integration/card/associations/checklists_spec.rb +18 -0
  210. data/spec/integration/card/associations/comments_spec.rb +19 -0
  211. data/spec/integration/card/associations/cover_image_spec.rb +18 -0
  212. data/spec/integration/card/associations/custom_field_items_spec.rb +18 -0
  213. data/spec/integration/card/associations/list_spec.rb +16 -0
  214. data/spec/integration/card/associations/members_spec.rb +18 -0
  215. data/spec/integration/card/associations/plugin_data_spec.rb +18 -0
  216. data/spec/integration/card/associations/voters_spec.rb +17 -0
  217. data/spec/integration/card/close!_spec.rb +16 -0
  218. data/spec/integration/card/create_new_check_list_spec.rb +19 -0
  219. data/spec/integration/card/create_spec.rb +84 -0
  220. data/spec/integration/card/delete_spec.rb +16 -0
  221. data/spec/integration/card/find_spec.rb +67 -0
  222. data/spec/integration/card/move_to_board_spec.rb +36 -0
  223. data/spec/integration/card/move_to_list_spec.rb +20 -0
  224. data/spec/integration/card/remove_member_spec.rb +19 -0
  225. data/spec/integration/card/save_spec.rb +61 -0
  226. data/spec/integration/card/update!_spec.rb +53 -0
  227. data/spec/integration/card/vote_spec.rb +50 -0
  228. data/spec/integration/checklist/add_item_spec.rb +20 -0
  229. data/spec/integration/checklist/create_spec.rb +23 -0
  230. data/spec/integration/checklist/delete_spec.rb +17 -0
  231. data/spec/integration/checklist/find_spec.rb +22 -0
  232. data/spec/integration/checklist/update!_spec.rb +21 -0
  233. data/spec/integration/checklist/update_item_state_spec.rb +20 -0
  234. data/spec/integration/comment/association/board_spec.rb +17 -0
  235. data/spec/integration/comment/association/card_spec.rb +17 -0
  236. data/spec/integration/comment/association/list_spec.rb +17 -0
  237. data/spec/integration/comment/delete_spec.rb +20 -0
  238. data/spec/integration/comment/find_spec.rb +17 -0
  239. data/spec/integration/custom_field/association/board_spec.rb +18 -0
  240. data/spec/integration/custom_field/association/custom_field_options_spec.rb +18 -0
  241. data/spec/integration/custom_field/create_spec.rb +29 -0
  242. data/spec/integration/custom_field/find_spec.rb +41 -0
  243. data/spec/integration/custom_field/update!_spec.rb +25 -0
  244. data/spec/integration/custom_field_item_spec.rb +47 -0
  245. data/spec/integration/custom_field_option/create_spec.rb +23 -0
  246. data/spec/integration/custom_field_option/delete_spec.rb +19 -0
  247. data/spec/integration/custom_field_option/find_spec.rb +21 -0
  248. data/spec/integration/label/association/board_spec.rb +18 -0
  249. data/spec/integration/label/create_spec.rb +23 -0
  250. data/spec/integration/label/delete_spec.rb +21 -0
  251. data/spec/integration/label/find_spec.rb +20 -0
  252. data/spec/integration/label/update!_spec.rb +25 -0
  253. data/spec/integration/list/archive_all_cards_spec.rb +20 -0
  254. data/spec/integration/list/associations/actions_spec.rb +18 -0
  255. data/spec/integration/list/associations/board_spec.rb +18 -0
  256. data/spec/integration/list/associations/cards_spec.rb +18 -0
  257. data/spec/integration/list/create_spec.rb +44 -0
  258. data/spec/integration/list/find_spec.rb +37 -0
  259. data/spec/integration/list/move_all_cards_spec.rb +31 -0
  260. data/spec/integration/list/save_spec.rb +40 -0
  261. data/spec/integration/list/update!_spec.rb +43 -0
  262. data/spec/integration/member/associations/actions_spec.rb +17 -0
  263. data/spec/integration/member/associations/boards_spec.rb +18 -0
  264. data/spec/integration/member/associations/cards_spec.rb +18 -0
  265. data/spec/integration/member/associations/notifications_spec.rb +18 -0
  266. data/spec/integration/member/associations/organizations_spec.rb +18 -0
  267. data/spec/integration/member/find_spec.rb +39 -0
  268. data/spec/integration/member/update!_spec.rb +18 -0
  269. data/spec/integration/notification/find_spec.rb +27 -0
  270. data/spec/integration/organization/associations/actions_spec.rb +18 -0
  271. data/spec/integration/organization/associations/boards_spec.rb +18 -0
  272. data/spec/integration/organization/associations/members_spec.rb +18 -0
  273. data/spec/integration/organization/create_spec.rb +23 -0
  274. data/spec/integration/organization/find_spec.rb +37 -0
  275. data/spec/integration/organization/update!_spec.rb +28 -0
  276. data/spec/integration/token/find_spec.rb +24 -0
  277. data/spec/integration/webhook/create_spec.rb +27 -0
  278. data/spec/integration/webhook/delete_spec.rb +21 -0
  279. data/spec/integration/webhook/find_spec.rb +22 -0
  280. data/spec/integration/webhook/update!_spec.rb +24 -0
  281. data/spec/item_spec.rb +2 -2
  282. data/spec/label_spec.rb +105 -28
  283. data/spec/list_spec.rb +32 -14
  284. data/spec/notification_spec.rb +3 -3
  285. data/spec/organization_spec.rb +6 -5
  286. data/spec/spec_helper.rb +70 -37
  287. data/spec/token_spec.rb +10 -11
  288. data/spec/unit/trello/association_builder/has_many_spec.rb +36 -0
  289. data/spec/unit/trello/association_builder/has_one_spec.rb +36 -0
  290. data/spec/unit/trello/association_fetcher/has_many/fetch_spec.rb +38 -0
  291. data/spec/unit/trello/association_fetcher/has_many/params_spec.rb +107 -0
  292. data/spec/unit/trello/association_fetcher/has_many_spec.rb +50 -0
  293. data/spec/unit/trello/association_fetcher/has_one/fetch_spec.rb +51 -0
  294. data/spec/unit/trello/association_fetcher/has_one/params_spec.rb +81 -0
  295. data/spec/unit/trello/association_fetcher/has_one_spec.rb +49 -0
  296. data/spec/unit/trello/association_infer_tool_spec.rb +41 -0
  297. data/spec/unit/trello/basic_data_spec.rb +113 -0
  298. data/spec/unit/trello/board/new_spec.rb +370 -0
  299. data/spec/unit/trello/board/save_spec.rb +49 -0
  300. data/spec/unit/trello/board/update_fields_spec.rb +129 -0
  301. data/spec/unit/trello/board/update_spec.rb +197 -0
  302. data/spec/unit/trello/card_spec.rb +103 -0
  303. data/spec/unit/trello/member/new_spec.rb +62 -0
  304. data/spec/unit/trello/member/update_fields_spec.rb +80 -0
  305. data/spec/unit/trello/schema/attribute/base_spec.rb +349 -0
  306. data/spec/unit/trello/schema/attribute/board_pref_spec.rb +208 -0
  307. data/spec/unit/trello/schema/attribute/default_spec.rb +236 -0
  308. data/spec/unit/trello/schema/attribute_builder_spec.rb +55 -0
  309. data/spec/unit/trello/schema/attribute_registration_spec.rb +59 -0
  310. data/spec/unit/trello/schema/serializer/default_spec.rb +19 -0
  311. data/spec/unit/trello/schema/serializer/time_spec.rb +39 -0
  312. data/spec/unit/trello/schema_spec.rb +25 -0
  313. data/spec/webhook_spec.rb +23 -7
  314. metadata +556 -33
@@ -1,9 +1,30 @@
1
1
  module Trello
2
2
  # A custom field item contains the value for a custom field on a particular card.
3
3
  #
4
+ # @!attribute [r] id
5
+ # @return [String]
6
+ # @!attribute [r] model_id
7
+ # @return [String]
8
+ # @!attribute [r] model_type
9
+ # @return [String]
10
+ # @!attribute [r] custom_field_id
11
+ # @return [String]
12
+ # @!attribute [r] option_id
13
+ # @return [String]
14
+ # @!attribute [rw] value
15
+ # @return [Hash]
4
16
  class CustomFieldItem < BasicData
5
- register_attributes :id, :model_id, :model_type, :custom_field_id, :value, :option_id,
6
- readonly: [ :id, :custom_field_id, :model_id, :model_type, :option_id ]
17
+
18
+ schema do
19
+ attribute :id, readonly: true, primary_key: true
20
+ attribute :model_id, readonly: true, remote_key: 'idModel'
21
+ attribute :model_type, readonly: true, remote_key: 'modelType'
22
+ attribute :custom_field_id, readonly: true, remote_key: 'idCustomField'
23
+ attribute :option_id, readonly: true, remote_key: 'idValue'
24
+
25
+ attribute :value
26
+ end
27
+
7
28
  validates_presence_of :id, :model_id, :custom_field_id
8
29
 
9
30
  # References the card with this custom field value
@@ -12,56 +33,33 @@ module Trello
12
33
  # References the parent custom field that this item is an instance of
13
34
  one :custom_field, path: 'customFields', using: :custom_field_id
14
35
 
15
- # Update the fields of a custom field item.
16
- #
17
- # Supply a hash of string keyed data retrieved from the Trello API representing
18
- # an item state.
19
- def update_fields(fields)
20
- attributes[:id] = fields['id'] || fields[:id] || attributes[:id]
21
- attributes[:model_id] = fields['idModel'] || fields[:model_id] || attributes[:model_id]
22
- attributes[:custom_field_id] = fields['idCustomField'] || fields[:custom_field_id] || attributes[:custom_field_id]
23
- attributes[:model_type] = fields['modelType'] || fields[:model_type] || attributes[:model_type]
24
- # Dropdown custom field items do not have a value, they have an ID that maps to
25
- # a different endpoint to get the value
26
- attributes[:option_id] = fields['idValue'] if fields.has_key?('idValue')
27
- # value format: { "text": "hello world" }
28
- attributes[:value] = fields['value'] if fields.has_key?('value')
29
- self
30
- end
36
+ def save
37
+ return update! if id
38
+
39
+ payload = {}
31
40
 
32
- def update!
33
- @previously_changed = changes
34
- # extract only new values to build payload
35
- payload = Hash[changes.map { |key, values| [key.to_sym, values[1]] }]
36
- @changed_attributes.try(:clear)
37
- changes_applied if respond_to?(:changes_applied)
41
+ schema.attrs.each do |_, attribute|
42
+ payload = attribute.build_payload_for_create(attributes, payload)
43
+ end
38
44
 
39
- client.put("/card/#{model_id}/customField/#{custom_field_id}/item", payload)
45
+ put(element_path, payload)
40
46
  end
41
47
 
42
- # Saves a record.
43
- #
44
- # @raise [Trello::Error] if the card could not be saved
45
- #
46
- # @return [String] The JSON representation of the saved custom field item returned by
47
- # the Trello API.
48
- def save
49
- # If we have an id, just update our fields.
50
- return update! if id
48
+ def collection_path
49
+ "/cards/#{model_id}/#{collection_name}"
50
+ end
51
51
 
52
- from_response client.post("/card/#{model_id}/customField/#{custom_field_id}/item", {
53
- value: value
54
- })
52
+ def element_path
53
+ "/cards/#{model_id}/customField/#{custom_field_id}/item"
55
54
  end
56
55
 
57
56
  # You can't "delete" a custom field item, you can only clear the value
58
57
  def remove
59
58
  params = { value: {} }
60
- client.put("/card/#{model_id}/customField/#{custom_field_id}/item", params)
59
+ client.put(element_path, params)
61
60
  end
62
61
 
63
62
  # Type is saved at the CustomField level
64
- # Can equally be derived from :value, with a little parsing work: {"number": 42}
65
63
  def type
66
64
  custom_field.type
67
65
  end
@@ -1,22 +1,49 @@
1
1
  module Trello
2
2
  # A custom field option contains the individual items in a custom field dropdown menu.
3
3
  #
4
+ # @!attribute [r] id
5
+ # @return [String]
6
+ # @!attribute [r] custom_field_id
7
+ # @return [String]
8
+ # @!attribute [rw] value
9
+ # @return [Hash]
10
+ # @!attribute [rw] color
11
+ # @return [String]
12
+ # @!attribute [rw] position
13
+ # @return [Float]
4
14
  class CustomFieldOption < BasicData
5
- register_attributes :id, :value, :pos, :color,
6
- readonly: [:id]
15
+
16
+ schema do
17
+ # Readonly
18
+ attribute :id, remote_key: '_id', readonly: true, primary_key: true
19
+ attribute :custom_field_id, remote_key: 'idCustomField', readonly: true
20
+
21
+ # Writable but for create only
22
+ attribute :value, create_only: true
23
+ attribute :color, create_only: true
24
+ attribute :position, remote_key: 'pos', create_only: true
25
+ end
26
+
7
27
  validates_presence_of :id, :value
8
28
 
9
- # Update the fields of a custom field option.
10
- #
11
- # Supply a hash of string keyed data retrieved from the Trello API representing
12
- # an item state.
13
- def update_fields(fields)
14
- attributes[:id] = fields['_id'] || fields[:id] || attributes[:id]
15
- attributes[:color] = fields['color'] || fields[:color] || attributes[:color]
16
- attributes[:pos] = fields['pos'] || fields[:pos] || attributes[:pos]
17
- # value format: { "text": "hello world" }
18
- attributes[:value] = fields['value'] || fields[:value] || attributes[:value]
19
- self
29
+ def self.find(id, params = {})
30
+ params = params.with_indifferent_access
31
+ custom_field_id = params.delete(:custom_field_id)
32
+ return if custom_field_id.nil?
33
+
34
+ from_response client.get("/customFields/#{custom_field_id}/options/#{id}")
35
+ end
36
+
37
+ def delete
38
+ client.delete(element_path)
39
+ end
40
+
41
+ def collection_path
42
+ "/customFields/#{custom_field_id}/options"
43
+ end
44
+
45
+ def element_path
46
+ "/customFields/#{custom_field_id}/options/#{id}"
20
47
  end
21
48
  end
22
49
  end
data/lib/trello/item.rb CHANGED
@@ -5,31 +5,42 @@ module Trello
5
5
  # @return [String]
6
6
  # @!attribute [r] name
7
7
  # @return [String]
8
+ # @!attribute [r] name_data
9
+ # @return [String]
8
10
  # @!attribute [r] type
9
11
  # @return [Object]
10
12
  # @!attribute [r] state
11
13
  # @return [Object]
12
- # @!attribute [r] pos
14
+ # @!attribute [r] position
13
15
  # @return [Object]
16
+ # @!attribute [r] due_date
17
+ # @return [Datetime]
18
+ # @!attribute [r] member_id
19
+ # @return [String]
20
+ # @!attribute [r] checklist_id
21
+ # @return [String]
22
+ # @!attribute [w] checked
23
+ # @return [Boolean]
14
24
  class Item < BasicData
15
- register_attributes :id, :name, :type, :state, :pos, readonly: [ :id, :name, :type, :state, :pos ]
16
- validates_presence_of :id, :type
17
25
 
18
- # Updates the fields of an item.
19
- #
20
- # Supply a hash of string keyed data retrieved from the Trello API representing
21
- # an item.
22
- def update_fields(fields)
23
- attributes[:id] = fields['id'] || attributes[:id]
24
- attributes[:card_id] = fields['idCard'] || attributes[:card_id]
25
- attributes[:checklist_id] = fields['idChecklist'] || attributes[:checklist_id]
26
- attributes[:name] = fields['name'] || attributes[:name]
27
- attributes[:type] = fields['type'] || attributes[:type]
28
- attributes[:state] = fields['state'] || attributes[:state]
29
- attributes[:pos] = fields['pos'] || attributes[:pos]
30
- self
26
+ schema do
27
+ # Readonly
28
+ attribute :id, readonly: true, primary_key: true
29
+ attribute :type, readonly: true
30
+ attribute :name_data, readonly: true, remote_key: 'nameData'
31
+ attribute :due_date, readonly: true, remote_key: 'due', serializer: 'Time'
32
+ attribute :member_id, readonly: true, remote_key: 'idMember'
33
+ attribute :state, readonly: true
34
+ attribute :checklist_id, readonly: true, remote_key: 'idChecklist'
35
+
36
+ # Writable and write only
37
+ attribute :name, write_only: true
38
+ attribute :position, write_only: true, remote_key: 'pos'
39
+ attribute :checked, write_only: true
31
40
  end
32
41
 
42
+ validates_presence_of :id
43
+
33
44
  def complete?
34
45
  state == "complete"
35
46
  end
@@ -5,26 +5,18 @@ module Trello
5
5
  # @return [String]
6
6
  # @!attribute [r] state
7
7
  # @return [Object]
8
- # @!attribute [r] item_id
9
- # @return [String]
10
8
  class CheckItemState < BasicData
11
- register_attributes :id, :state, :item_id, readonly: [ :id, :state, :item_id ]
12
- validates_presence_of :id, :item_id
13
-
14
- # Update the fields of an item state.
15
- #
16
- # Supply a hash of string keyed data retrieved from the Trello API representing
17
- # an item state.
18
- def update_fields(fields)
19
- attributes[:id] = fields['id'] || attributes[:id]
20
- attributes[:state] = fields['state'] || attributes[:state]
21
- attributes[:item_id] = fields['idCheckItem'] || attributes[:item_id]
22
- self
9
+ schema do
10
+ #Readonly
11
+ attribute :id, remote_key: 'idCheckItem', readonly: true, primary_key: true
12
+ attribute :state
23
13
  end
24
14
 
15
+ validates_presence_of :id
16
+
25
17
  # Return the item this state belongs to.
26
18
  def item
27
- Item.find(item_id)
19
+ Item.find(id)
28
20
  end
29
21
  end
30
22
  end
@@ -7,7 +7,7 @@ module Trello
7
7
 
8
8
  module InstanceMethods
9
9
  def from_response(*args)
10
- update_fields parse_json(*args)
10
+ initialize_fields parse_json(*args)
11
11
  end
12
12
 
13
13
  def parse_json(*args)
data/lib/trello/label.rb CHANGED
@@ -6,104 +6,34 @@ module Trello
6
6
  # @return [String]
7
7
  # @!attribute [rw] color
8
8
  # @return [String]
9
+ # @!attribute [rw] name
10
+ # @return [String]
11
+ # @!attribute [rw] board_id
12
+ # @return [String]
9
13
  class Label < BasicData
10
- register_attributes :id, :name, :board_id, :uses,
11
- readonly: [ :id, :uses, :board_id ]
12
- validates_presence_of :id, :board_id, :name
13
- validates_length_of :name, in: 1..16384
14
-
15
- SYMBOL_TO_STRING = {
16
- id: 'id',
17
- name: 'name',
18
- board_id: 'idBoard',
19
- color: 'color',
20
- uses: 'uses'
21
- }
22
-
23
- class << self
24
- VALID_LABEL_COLOURS = %w{green yellow orange red purple blue sky lime pink black} << ''
25
-
26
- # Find a specific label by its id.
27
- def find(id, params = {})
28
- client.find(:label, id, params)
29
- end
30
-
31
- # Create a new label and save it on Trello.
32
- def create(options)
33
- client.create(:label,
34
- 'name' => options[:name],
35
- 'idBoard' => options[:board_id],
36
- 'color' => options[:color],
37
- )
38
- end
39
-
40
- # Label colours
41
- def label_colours
42
- VALID_LABEL_COLOURS
43
- end
44
- end
45
-
46
- define_attribute_methods [:color]
47
14
 
48
- def color
49
- @__attributes[:color]
50
- end
15
+ schema do
16
+ # Readonly
17
+ attribute :id, readonly: true, primary_key: true
51
18
 
52
- def color= colour
53
- unless Label.label_colours.include? colour
54
- errors.add(:label, "color '#{colour}' does not exist")
55
- return Trello.logger.warn "The label colour '#{colour}' does not exist."
56
- end
19
+ # Writable
20
+ attribute :name
21
+ attribute :color
57
22
 
58
- self.send(:"color_will_change!") unless colour == @__attributes[:color]
59
- @__attributes[:color] = colour
23
+ # Writable but for create only
24
+ attribute :board_id, create_only: true, remote_key: 'idBoard'
60
25
  end
61
26
 
62
- # Update the fields of a label.
63
- #
64
- # Supply a hash of stringkeyed data retrieved from the Trello API representing
65
- # a label.
66
- def update_fields(fields)
67
- attributes[:id] = fields['id'] || attributes[:id]
68
- attributes[:name] = fields['name'] || fields[:name] || attributes[:name]
69
- attributes[:color] = fields['color'] || fields[:color] || attributes[:color]
70
- attributes[:board_id] = fields['idBoard'] || fields[:board_id] || attributes[:board_id]
71
- attributes[:uses] = fields['uses'] if fields.has_key?('uses')
72
- self
73
- end
27
+ validates_presence_of :id, :board_id, :name
28
+ validates_length_of :name, in: 1..16384
74
29
 
75
30
  # Returns a reference to the board this label is currently connected.
76
31
  one :board, path: :boards, using: :board_id
77
32
 
78
- # Saves a record.
79
- def save
80
- # If we have an id, just update our fields.
81
- return update! if id
82
-
83
- from_response client.post("/labels", {
84
- name: name,
85
- color: color,
86
- idBoard: board_id,
87
- })
88
- end
89
-
90
- # Update an existing record.
91
- # Warning, this updates all fields using values already in memory. If
92
- # an external resource has updated these fields, you should refresh!
93
- # this object before making your changes, and before updating the record.
94
- def update!
95
- @previously_changed = changes
96
- # extract only new values to build payload
97
- payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }]
98
- @changed_attributes.try(:clear)
99
- changes_applied if respond_to?(:changes_applied)
100
-
101
- client.put("/labels/#{id}", payload)
102
- end
103
-
104
33
  # Delete this label
105
34
  def delete
106
35
  client.delete("/labels/#{id}")
107
36
  end
37
+
108
38
  end
109
39
  end
@@ -1,31 +1,28 @@
1
1
  module Trello
2
-
3
2
  # A colored Label attached to a card
3
+ #
4
+ # @!attribute [r] yellow
5
+ # @!attribute [r] red
6
+ # @!attribute [r] orange
7
+ # @!attribute [r] green
8
+ # @!attribute [r] purple
9
+ # @!attribute [r] blue
10
+ # @!attribute [r] sky
11
+ # @!attribute [r] pink
12
+ # @!attribute [r] lime
13
+ # @!attribute [r] black
4
14
  class LabelName < BasicData
5
- register_attributes :yellow, :red, :orange, :green, :purple, :blue, :sky, :pink, :lime, :black
6
-
7
- # Update the fields of a label.
8
- #
9
- # Supply a hash of stringkeyed data retrieved from the Trello API representing
10
- # a label.
11
- def update_fields(fields)
12
- attributes[:yellow] = fields['yellow'] || attributes[:yellow]
13
- attributes[:red] = fields['red'] || attributes[:red]
14
- attributes[:orange] = fields['orange'] || attributes[:orange]
15
- attributes[:green] = fields['green'] || attributes[:green]
16
- attributes[:purple] = fields['purple'] || attributes[:purple]
17
- attributes[:blue] = fields['blue'] || attributes[:blue]
18
- attributes[:sky] = fields['sky'] || attributes[:sky]
19
- attributes[:pink] = fields['pink'] || attributes[:pink]
20
- attributes[:lime] = fields['lime'] || attributes[:lime]
21
- attributes[:black] = fields['black'] || attributes[:black]
22
-
23
- self
15
+ schema do
16
+ attribute :yellow, readonly: true
17
+ attribute :red, readonly: true
18
+ attribute :orange, readonly: true
19
+ attribute :green, readonly: true
20
+ attribute :purple, readonly: true
21
+ attribute :blue, readonly: true
22
+ attribute :sky, readonly: true
23
+ attribute :pink, readonly: true
24
+ attribute :lime, readonly: true
25
+ attribute :black, readonly: true
24
26
  end
25
-
26
- one :board, path: :boards, using: :board_id
27
-
28
- many :cards, filter: :all
29
-
30
27
  end
31
28
  end
data/lib/trello/list.rb CHANGED
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  module Trello
2
4
  # A List is a container which holds cards. Lists are items on a board.
3
5
  #
@@ -11,10 +13,30 @@ module Trello
11
13
  # @return [String] A 24-character hex string
12
14
  # @!attribute [rw] pos
13
15
  # @return [Object]
16
+ # @!attribute [w] source_list_id
17
+ # @return [String]
18
+ # @!attribute [w] subscribed
19
+ # @return [Boolean]
14
20
  class List < BasicData
15
- register_attributes :id, :name, :closed, :board_id, :pos, :source_list_id, readonly: [ :id, :board_id ]
21
+ schema do
22
+ # Readonly
23
+ attribute :id, readonly: true, primary_key: true
24
+
25
+ # Writable
26
+ attribute :name
27
+ attribute :pos
28
+ attribute :board_id, remote_key: 'idBoard'
29
+
30
+ # Writable but for create only
31
+ attribute :source_list_id, create_only: true, remote_key: 'idListSource'
32
+
33
+ # Writable but for update only
34
+ attribute :closed, update_only: true
35
+ attribute :subscribed, update_only: true
36
+ end
37
+
16
38
  validates_presence_of :id, :name, :board_id
17
- validates_length_of :name, in: 1..16384
39
+ validates_length_of :name, in: 1..16_384
18
40
 
19
41
  include HasActions
20
42
 
@@ -26,48 +48,6 @@ module Trello
26
48
  def find(id, params = {})
27
49
  client.find(:list, id, params)
28
50
  end
29
-
30
- def create(options)
31
- client.create(:list,
32
- 'name' => options[:name],
33
- 'idBoard' => options[:board_id],
34
- 'pos' => options[:pos],
35
- 'idListSource' => options[:source_list_id])
36
- end
37
- end
38
-
39
- # Updates the fields of a list.
40
- #
41
- # Supply a hash of string keyed data retrieved from the Trello API representing
42
- # a List.
43
- def update_fields(fields)
44
- attributes[:id] = fields['id'] || attributes[:id]
45
- attributes[:name] = fields['name'] || fields[:name] || attributes[:name]
46
- attributes[:closed] = fields['closed'] if fields.has_key?('closed')
47
- attributes[:board_id] = fields['idBoard'] || fields[:board_id] || attributes[:board_id]
48
- attributes[:pos] = fields['pos'] || fields[:pos] || attributes[:pos]
49
- attributes[:source_list_id] = fields['idListSource'] || fields[:source_list_id] || attributes[:source_list_id]
50
- self
51
- end
52
-
53
- def save
54
- return update! if id
55
-
56
- from_response client.post("/lists", {
57
- name: name,
58
- closed: closed || false,
59
- idBoard: board_id,
60
- pos: pos,
61
- idListSource: source_list_id
62
- })
63
- end
64
-
65
- def update!
66
- client.put("/lists/#{id}", {
67
- name: name,
68
- closed: closed,
69
- pos: pos
70
- })
71
51
  end
72
52
 
73
53
  # Check if the list is not active anymore.
@@ -101,6 +81,13 @@ module Trello
101
81
  })
102
82
  end
103
83
 
84
+ # Move list to another board. Accepts a `Trello::Board` or an id string.
85
+ def move_to_board(board)
86
+ board = board.id unless board.is_a?(String)
87
+
88
+ client.put("/lists/#{id}/idBoard", value: board)
89
+ end
90
+
104
91
  # Archives all the cards of the list
105
92
  def archive_all_cards
106
93
  client.post("/lists/#{id}/archiveAllCards")
data/lib/trello/member.rb CHANGED
@@ -17,8 +17,84 @@ module Trello
17
17
  # @return [String]
18
18
  # @!attribute [r] url
19
19
  # @return [String]
20
+ # @!attribute [r] prefs
21
+ # @return [Hash]
22
+ # @!attribute [r] activity_blocked
23
+ # @return [Boolean]
24
+ # @!attribute [r] bio_data
25
+ # @return [Hash]
26
+ # @!attribute [r] confirmed
27
+ # @return [Boolean]
28
+ # @!attribute [r] enterprise_id
29
+ # @return [String]
30
+ # @!attribute [r] deactivated_enterprise_ids
31
+ # @return [String]
32
+ # @!attribute [r] referrer_member_id
33
+ # @return [String]
34
+ # @!attribute [r] admin_orgs_perm_id
35
+ # @return [String]
36
+ # @!attribute [r] member_type
37
+ # @return [String]
38
+ # @!attribute [r] non_public
39
+ # @return [Hash]
40
+ # @!attribute [r] non_public_available
41
+ # @return [Hash]
42
+ # @!attribute [r] products
43
+ # @return [Array]
44
+ # @!attribute [r] status
45
+ # @return [String]
46
+ # @!attribute [r] board_ids
47
+ # @return [Array<String>]
48
+ # @!attribute [r] organization_ids
49
+ # @return [Array<String>]
50
+ # @!attribute [r] admin_enterprise_ids
51
+ # @return [Array<String>]
52
+ # @!attribute [r] limits
53
+ # @return [Hash]
54
+ # @!attribute [r] login_types
55
+ # @return [Array<String>]
56
+ # @!attribute [r] marketing_opt_in
57
+ # @return [Hash]
58
+ # @!attribute [r] pinned_board_ids
59
+ # @return [String]
60
+ # @!attribute [w] avatar_source
61
+ # @return [String]
20
62
  class Member < BasicData
21
- register_attributes :id, :username, :email, :full_name, :initials, :avatar_id, :bio, :url, readonly: [ :id, :username, :avatar_id, :url ]
63
+ schema do
64
+ # readonly
65
+ attribute :id, readonly: true, primary_key: true
66
+ attribute :email, readonly: true
67
+ attribute :avatar_id, readonly: true, remote_key: 'avatarHash'
68
+ attribute :url, readonly: true
69
+ attribute :prefs, readonly: true
70
+ attribute :activity_blocked, readonly: true, remote_key: 'activityBlocked'
71
+ attribute :bio_data, readonly: true, remote_key: 'bioData'
72
+ attribute :confirmed, readonly: true
73
+ attribute :enterprise_id, readonly: true, remote_key: 'idEnterprise'
74
+ attribute :deactivated_enterprise_ids, readonly: true, remote_key: 'idEnterprisesDeactivated'
75
+ attribute :referrer_member_id, readonly: true, remote_key: 'idMemberReferrer'
76
+ attribute :admin_orgs_perm_id, readonly: true, remote_key: 'idPremOrgsAdmin'
77
+ attribute :member_type, readonly: true, remote_key: 'memberType'
78
+ attribute :non_public, readonly: true, remote_key: 'nonPublic'
79
+ attribute :non_public_available, readonly: true, remote_key: 'nonPublicAvailable'
80
+ attribute :products, readonly: true
81
+ attribute :status, readonly: true
82
+ attribute :board_ids, readonly: true, remote_key: 'idBoards'
83
+ attribute :organization_ids, readonly: true, remote_key: 'idOrganizations'
84
+ attribute :admin_enterprise_ids, readonly: true, remote_key: 'idEnterprisesAdmin'
85
+ attribute :limits, readonly: true
86
+ attribute :login_types, readonly: true, remote_key: 'loginTypes'
87
+ attribute :marketing_opt_in, readonly: true, remote_key: 'marketingOptIn'
88
+ attribute :pinned_board_ids, readonly: true, remote_key: 'idBoardsPinned'
89
+
90
+ # writable
91
+ attribute :username
92
+ attribute :full_name, remote_key: 'fullName'
93
+ attribute :initials
94
+ attribute :bio
95
+ attribute :avatar_source, remote_key: 'avatarSource'
96
+ end
97
+
22
98
  validates_presence_of :id, :username
23
99
  validates_length_of :full_name, minimum: 4
24
100
  validates_length_of :bio, maximum: 16384
@@ -34,22 +110,6 @@ module Trello
34
110
  end
35
111
  end
36
112
 
37
- # Update the fields of a member.
38
- #
39
- # Supply a hash of string keyed data retrieved from the Trello API representing
40
- # an Member.
41
- def update_fields(fields)
42
- attributes[:id] = fields['id'] || attributes[:id]
43
- attributes[:full_name] = fields['fullName'] || attributes[:full_name]
44
- attributes[:email] = fields['email'] || attributes[:email]
45
- attributes[:username] = fields['username'] || attributes[:username]
46
- attributes[:initials] = fields['initials'] || attributes[:initials]
47
- attributes[:avatar_id] = fields['avatarHash'] || attributes[:avatar_id]
48
- attributes[:bio] = fields['bio'] || attributes[:bio]
49
- attributes[:url] = fields['url'] || attributes[:url]
50
- self
51
- end
52
-
53
113
  # Retrieve a URL to the avatar.
54
114
  #
55
115
  # Valid values for options are:
@@ -90,21 +150,6 @@ module Trello
90
150
  # Returns a list of notifications for the user
91
151
  many :notifications
92
152
 
93
- def save
94
- @previously_changed = changes
95
- @changed_attributes.try(:clear)
96
- changes_applied if respond_to?(:changes_applied)
97
-
98
- return update! if id
99
- end
100
-
101
- def update!
102
- from_response client.put(request_prefix, {
103
- fullName: full_name,
104
- bio: bio
105
- })
106
- end
107
-
108
153
  # :nodoc:
109
154
  def request_prefix
110
155
  "/members/#{id}"