Class: Trello::Card
- Includes:
- HasActions
- Defined in:
- lib/trello/card.rb
Overview
A Card is a container that can house checklists and comments; it resides inside a List.
Constant Summary collapse
- SYMBOL_TO_STRING =
{ id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" }
Instance Attribute Summary collapse
- #badges ⇒ Hash readonly
-
#board_id ⇒ String
A 24-character hex string.
- #card_labels ⇒ Array<Hash>
- #card_members ⇒ Object readonly
- #closed ⇒ Boolean
-
#cover_image_id ⇒ String
A 24-character hex string.
- #desc ⇒ String
- #due ⇒ Datetime
- #id ⇒ String readonly
- #labels ⇒ Array<Trello::Labels>
- #last_activity_date ⇒ Dateime readonly
-
#list_id ⇒ String
A 24-character hex string.
-
#member_ids ⇒ Array<String>
An Array of 24-character hex strings.
- #name ⇒ String
- #pos ⇒ Float
- #short_id ⇒ Fixnum readonly
- #short_url ⇒ String readonly
-
#source_card_id ⇒ String
A 24-character hex string.
-
#source_card_properties ⇒ Array<String>
Array of strings.
- #url ⇒ String readonly
Attributes inherited from BasicData
Class Method Summary collapse
-
.create(options) ⇒ Trello::Card
Create a new card and save it on Trello.
-
.find(id, params = {}) ⇒ Trello::Card
Find a specific card by its id.
Instance Method Summary collapse
-
#add_attachment(attachment, name = '') ⇒ Object
Add an attachment to this card.
-
#add_checklist(checklist) ⇒ Object
Add a checklist to this card.
-
#add_comment(text) ⇒ Object
Add a comment with the supplied text.
-
#add_label(label) ⇒ Object
Add a label.
-
#add_member(member) ⇒ Object
Add a member to this card.
-
#attachments ⇒ Object
Retrieve a list of attachments.
- #check_item_states ⇒ Object
-
#close ⇒ Boolean, String
Close the card.
- #close! ⇒ Object
-
#closed? ⇒ Boolean
Check if the card is not active anymore.
-
#comments ⇒ Object
Retrieve a list of comments.
-
#create_new_checklist(name) ⇒ Object
create a new checklist and add it to this card.
-
#created_at ⇒ Object
Find the creation date.
-
#delete ⇒ String
Delete this card.
-
#members ⇒ Array<Trello::Member>
Returns a list of members who are assigned to this card.
-
#move_to_board(new_board, new_list = nil) ⇒ Object
Move this card to the given board (and optional list on this board).
-
#move_to_list(list) ⇒ Object
Move this card to the given list.
-
#remove_attachment(attachment) ⇒ Object
Remove an attachment from this card.
-
#remove_label(label) ⇒ Object
Remove a label.
-
#remove_member(member) ⇒ Object
Remove a member from this card.
-
#remove_upvote ⇒ Object
Recind upvote.
-
#request_prefix ⇒ Object
:nodoc:.
-
#save ⇒ String
Saves a record.
-
#update! ⇒ String
Update an existing record.
-
#update_fields(fields) ⇒ Trello::Card
Update the fields of a card.
-
#upvote ⇒ Object
Current authenticated user upvotes a card.
-
#valid? ⇒ Boolean
Is the record valid?.
-
#voters ⇒ Array<Trello::Member>
Returns a list of members who have upvoted this card NOTE: this fetches a list each time it’s called to avoid case where card is voted (or vote is removed) after card is fetched.
Methods included from HasActions
Methods inherited from BasicData
#==, client, #initialize, many, one, parse, parse_many, path_name, #refresh!, register_attributes, save
Methods included from JsonUtils
Constructor Details
This class inherits a constructor from Trello::BasicData
Instance Attribute Details
#badges ⇒ Hash (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#board_id ⇒ String
Returns A 24-character hex string.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#card_labels ⇒ Array<Hash>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#card_members ⇒ Object (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#closed ⇒ Boolean
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#cover_image_id ⇒ String
Returns A 24-character hex string.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#desc ⇒ String
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#due ⇒ Datetime
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#id ⇒ String (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#labels ⇒ Array<Trello::Labels>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#last_activity_date ⇒ Dateime (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#list_id ⇒ String
Returns A 24-character hex string.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#member_ids ⇒ Array<String>
Returns An Array of 24-character hex strings.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#name ⇒ String
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#pos ⇒ Float
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#short_id ⇒ Fixnum (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#short_url ⇒ String (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#source_card_id ⇒ String
Returns A 24-character hex string.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#source_card_properties ⇒ Array<String>
Returns Array of strings.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
#url ⇒ String (readonly)
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 |
# File 'lib/trello/card.rb', line 45 class Card < BasicData register_attributes :id, :short_id, :name, :desc, :due, :due_complete, :closed, :url, :short_url, :board_id, :member_ids, :list_id, :pos, :last_activity_date, :labels, :card_labels, :cover_image_id, :badges, :card_members, :source_card_id, :source_card_properties, readonly: [ :id, :short_id, :url, :short_url, :last_activity_date, :badges, :card_members ] validates_presence_of :id, :name, :list_id validates_length_of :name, in: 1..16384 validates_length_of :desc, in: 0..16384 include HasActions SYMBOL_TO_STRING = { id: 'id', short_id: 'idShort', name: 'name', desc: 'desc', due: 'due', due_complete: 'dueComplete', closed: 'closed', url: 'url', short_url: 'shortUrl', board_id: 'idBoard', member_ids: 'idMembers', cover_image_id: 'idAttachmentCover', list_id: 'idList', pos: 'pos', last_activity_date: 'dateLastActivity', card_labels: 'idLabels', labels: 'labels', badges: 'badges', card_members: 'members', source_card_id: "idCardSource", source_card_properties: "keepFromSource" } class << self # Find a specific card by its id. # # @raise [Trello::Error] if the card could not be found. # # @return [Trello::Card] def find(id, params = {}) client.find(:card, id, params) end # Create a new card and save it on Trello. # # If using source_card_id to duplicate a card, make sure to save # the source card to Trello before calling this method to assure # the correct data is used in the duplication. # # @param [Hash] options # @option options [String] :name The name of the new card. # @option options [String] :list_id ID of the list that the card should # be added to. # @option options [String] :desc A string with a # length from 0 to 16384. # @option options [String] :member_ids A comma-separated list of # objectIds (24-character hex strings). # @option options [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option options [Date] :due A date, or `nil`. # @option options [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option options [String] :source_card_id ID of the card to copy # @option options [String] :source_card_properties A single, or array of, # string properties to copy from source card. # `"all"`, `"checklists"`, `"due"`, `"members"`, or `nil`. # Defaults to `"all"`. # # @raise [Trello::Error] if the card could not be created. # # @return [Trello::Card] def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end end # Update the fields of a card. # # Supply a hash of string keyed data retrieved from the Trello API representing # a card. # # Note that this this method does not save anything new to the Trello API, # it just assigns the input attributes to your local object. If you use # this method to assign attributes, call `save` or `update!` afterwards if # you want to persist your changes to Trello. # # @param [Hash] fields # @option fields [String] :id # @option fields [String] :short_id # @option fields [String] :name The new name of the card. # @option fields [String] :desc A string with a length from 0 to # 16384. # @option fields [Date] :due A date, or `nil`. # @option fields [Boolean] :due_complete # @option fields [Boolean] :closed # @option fields [String] :url # @option fields [String] :short_url # @option fields [String] :board_id # @option fields [String] :member_ids A comma-separated list of objectIds # (24-character hex strings). # @option fields [String] :pos A position. `"top"`, `"bottom"`, or a # positive number. Defaults to `"bottom"`. # @option fields [Array] :labels An Array of Trello::Label objects # derived from the JSON response # @option fields [String] :card_labels A comma-separated list of # objectIds (24-character hex strings). # @option fields [Object] :cover_image_id # @option fields [Object] :badges # @option fields [Object] :card_members # @option fields [String] :source_card_id # @option fields [Array] :source_card_properties # # @return [Trello::Card] self def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end # Returns a reference to the board this card is part of. one :board, path: :boards, using: :board_id # Returns a reference to the cover image attachment one :cover_image, path: :attachments, using: :cover_image_id # Returns a list of checklists associated with the card. # # The options hash may have a filter key which can have its value set as any # of the following values: # :filter => [ :none, :all ] # default :all many :checklists, filter: :all # Returns a list of plugins associated with the card many :plugin_data, path: "pluginData" def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end # Returns a reference to the list this card is currently in. one :list, path: :lists, using: :list_id # Returns a list of members who are assigned to this card. # # @return [Array<Trello::Member>] def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end # Returns a list of members who have upvoted this card # NOTE: this fetches a list each time it's called to avoid case where # card is voted (or vote is removed) after card is fetched. Optimizing # accuracy over network performance # # @return [Array<Trello::Member>] def voters Member.from_response client.get("/cards/#{id}/membersVoted") end # Saves a record. # # @raise [Trello::Error] if the card could not be saved # # @return [String] The JSON representation of the saved card returned by # the Trello API. def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end # Update an existing record. # # Warning: this updates all fields using values already in memory. If # an external resource has updated these fields, you should refresh! # this object before making your changes, and before updating the record. # # @raise [Trello::Error] if the card could not be updated. # # @return [String] The JSON representation of the updated card returned by # the Trello API. def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end # Delete this card # # @return [String] the JSON response from the Trello API def delete client.delete("/cards/#{id}") end # Check if the card is not active anymore. def closed? closed end # Close the card. # # This only marks your local copy card as closed. Use `close!` if you # want to close the card and persist the change to the Trello API. # # @return [Boolean] always returns true # # @return [String] The JSON representation of the closed card returned by # the Trello API. def close self.closed = true end def close! close save end # Is the record valid? def valid? name && list_id end # Add a comment with the supplied text. def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end # Add a checklist to this card def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end # create a new checklist and add it to this card def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end # Move this card to the given list def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end # Move this card to the given board (and optional list on this board) def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end # Add a member to this card def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end # Remove a member from this card def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end # Current authenticated user upvotes a card def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end # Recind upvote. Noop if authenticated user hasn't previously voted def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end # Add a label def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end # Remove a label def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end # Add an attachment to this card def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end # Retrieve a list of attachments def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end # Remove an attachment from this card def () client.delete("/cards/#{id}/attachments/#{.id}") end # :nodoc: def request_prefix "/cards/#{id}" end # Retrieve a list of comments def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end # Find the creation date def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end private def me @me ||= Member.find(:me) end end |
Class Method Details
.create(options) ⇒ Trello::Card
Create a new card and save it on Trello.
If using source_card_id to duplicate a card, make sure to save the source card to Trello before calling this method to assure the correct data is used in the duplication.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/trello/card.rb', line 118 def create() client.create(:card, 'name' => [:name], 'idList' => [:list_id], 'desc' => [:desc], 'idMembers' => [:member_ids], 'idLabels' => [:card_labels], 'due' => [:due], 'due_complete' => [:due_complete] || false, 'pos' => [:pos], 'idCardSource' => [:source_card_id], 'keepFromSource' => .key?(:source_card_properties) ? [:source_card_properties] : 'all' ) end |
.find(id, params = {}) ⇒ Trello::Card
Find a specific card by its id.
86 87 88 |
# File 'lib/trello/card.rb', line 86 def find(id, params = {}) client.find(:card, id, params) end |
Instance Method Details
#add_attachment(attachment, name = '') ⇒ Object
Add an attachment to this card
409 410 411 412 413 414 415 416 417 418 419 420 421 422 |
# File 'lib/trello/card.rb', line 409 def (, name = '') # Is it a file object or a string (url)? if .respond_to?(:path) && .respond_to?(:read) client.post("/cards/#{id}/attachments", { file: , name: name }) else client.post("/cards/#{id}/attachments", { url: , name: name }) end end |
#add_checklist(checklist) ⇒ Object
Add a checklist to this card
324 325 326 327 328 |
# File 'lib/trello/card.rb', line 324 def add_checklist(checklist) client.post("/cards/#{id}/checklists", { value: checklist.id }) end |
#add_comment(text) ⇒ Object
Add a comment with the supplied text.
319 320 321 |
# File 'lib/trello/card.rb', line 319 def add_comment(text) client.post("/cards/#{id}/actions/comments", text: text) end |
#add_label(label) ⇒ Object
Add a label
391 392 393 394 395 396 397 |
# File 'lib/trello/card.rb', line 391 def add_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.post("/cards/#{id}/idLabels", {value: label.id}) end |
#add_member(member) ⇒ Object
Add a member to this card
355 356 357 358 359 |
# File 'lib/trello/card.rb', line 355 def add_member(member) client.post("/cards/#{id}/members", { value: member.id }) end |
#attachments ⇒ Object
Retrieve a list of attachments
425 426 427 428 |
# File 'lib/trello/card.rb', line 425 def = Attachment.from_response client.get("/cards/#{id}/attachments") MultiAssociation.new(self, ).proxy end |
#check_item_states ⇒ Object
212 213 214 215 |
# File 'lib/trello/card.rb', line 212 def check_item_states states = CheckItemState.from_response client.get("/cards/#{self.id}/checkItemStates") MultiAssociation.new(self, states).proxy end |
#close ⇒ Boolean, String
Close the card.
This only marks your local copy card as closed. Use ‘close!` if you want to close the card and persist the change to the Trello API.
304 305 306 |
# File 'lib/trello/card.rb', line 304 def close self.closed = true end |
#close! ⇒ Object
308 309 310 311 |
# File 'lib/trello/card.rb', line 308 def close! close save end |
#closed? ⇒ Boolean
Check if the card is not active anymore.
291 292 293 |
# File 'lib/trello/card.rb', line 291 def closed? closed end |
#comments ⇒ Object
Retrieve a list of comments
441 442 443 |
# File 'lib/trello/card.rb', line 441 def comments comments = Comment.from_response client.get("/cards/#{id}/actions", filter: "commentCard") end |
#create_new_checklist(name) ⇒ Object
create a new checklist and add it to this card
331 332 333 |
# File 'lib/trello/card.rb', line 331 def create_new_checklist(name) client.post("/cards/#{id}/checklists", { name: name }) end |
#created_at ⇒ Object
Find the creation date
446 447 448 |
# File 'lib/trello/card.rb', line 446 def created_at @created_at ||= Time.at(id[0..7].to_i(16)) rescue nil end |
#delete ⇒ String
Delete this card
286 287 288 |
# File 'lib/trello/card.rb', line 286 def delete client.delete("/cards/#{id}") end |
#members ⇒ Array<Trello::Member>
Returns a list of members who are assigned to this card.
223 224 225 226 227 228 |
# File 'lib/trello/card.rb', line 223 def members members = member_ids.map do |member_id| Member.from_response client.get("/members/#{member_id}") end MultiAssociation.new(self, members).proxy end |
#move_to_board(new_board, new_list = nil) ⇒ Object
Move this card to the given board (and optional list on this board)
346 347 348 349 350 351 352 |
# File 'lib/trello/card.rb', line 346 def move_to_board(new_board, new_list = nil) unless board_id == new_board.id payload = { value: new_board.id } payload[:idList] = new_list.id if new_list client.put("/cards/#{id}/idBoard", payload) end end |
#move_to_list(list) ⇒ Object
Move this card to the given list
336 337 338 339 340 341 342 343 |
# File 'lib/trello/card.rb', line 336 def move_to_list(list) list_number = list.is_a?(String) ? list : list.id unless list_id == list_number client.put("/cards/#{id}/idList", { value: list_number }) end end |
#remove_attachment(attachment) ⇒ Object
Remove an attachment from this card
431 432 433 |
# File 'lib/trello/card.rb', line 431 def () client.delete("/cards/#{id}/attachments/#{.id}") end |
#remove_label(label) ⇒ Object
Remove a label
400 401 402 403 404 405 406 |
# File 'lib/trello/card.rb', line 400 def remove_label(label) unless label.valid? errors.add(:label, "is not valid.") return Trello.logger.warn "Label is not valid." unless label.valid? end client.delete("/cards/#{id}/idLabels/#{label.id}") end |
#remove_member(member) ⇒ Object
Remove a member from this card
362 363 364 |
# File 'lib/trello/card.rb', line 362 def remove_member(member) client.delete("/cards/#{id}/members/#{member.id}") end |
#remove_upvote ⇒ Object
Recind upvote. Noop if authenticated user hasn’t previously voted
380 381 382 383 384 385 386 387 388 |
# File 'lib/trello/card.rb', line 380 def remove_upvote begin client.delete("/cards/#{id}/membersVoted/#{me.id}") rescue Trello::Error => e fail e unless e. =~ /has not voted/i end self end |
#request_prefix ⇒ Object
:nodoc:
436 437 438 |
# File 'lib/trello/card.rb', line 436 def request_prefix "/cards/#{id}" end |
#save ⇒ String
Saves a record.
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'lib/trello/card.rb', line 246 def save # If we have an id, just update our fields. return update! if id from_response client.post("/cards", { name: name, desc: desc, idList: list_id, idMembers: member_ids, idLabels: card_labels, pos: pos, due: due, dueComplete: due_complete, idCardSource: source_card_id, keepFromSource: source_card_properties }) end |
#update! ⇒ String
Update an existing record.
Warning: this updates all fields using values already in memory. If an external resource has updated these fields, you should refresh! this object before making your changes, and before updating the record.
274 275 276 277 278 279 280 281 |
# File 'lib/trello/card.rb', line 274 def update! @previously_changed = changes # extract only new values to build payload payload = Hash[changes.map { |key, values| [SYMBOL_TO_STRING[key.to_sym].to_sym, values[1]] }] @changed_attributes.clear client.put("/cards/#{id}", payload) end |
#update_fields(fields) ⇒ Trello::Card
Update the fields of a card.
Supply a hash of string keyed data retrieved from the Trello API representing a card.
Note that this this method does not save anything new to the Trello API, it just assigns the input attributes to your local object. If you use this method to assign attributes, call ‘save` or `update!` afterwards if you want to persist your changes to Trello.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/trello/card.rb', line 171 def update_fields(fields) attributes[:id] = fields[SYMBOL_TO_STRING[:id]] attributes[:short_id] = fields[SYMBOL_TO_STRING[:short_id]] attributes[:name] = fields[SYMBOL_TO_STRING[:name]] || fields[:name] attributes[:desc] = fields[SYMBOL_TO_STRING[:desc]] || fields[:desc] attributes[:due] = Time.iso8601(fields[SYMBOL_TO_STRING[:due]]) rescue nil attributes[:due] ||= fields[:due] attributes[:due_complete] = fields[SYMBOL_TO_STRING[:due_complete]] || false attributes[:closed] = fields[SYMBOL_TO_STRING[:closed]] attributes[:url] = fields[SYMBOL_TO_STRING[:url]] attributes[:short_url] = fields[SYMBOL_TO_STRING[:short_url]] attributes[:board_id] = fields[SYMBOL_TO_STRING[:board_id]] attributes[:member_ids] = fields[SYMBOL_TO_STRING[:member_ids]] || fields[:member_ids] attributes[:list_id] = fields[SYMBOL_TO_STRING[:list_id]] || fields[:list_id] attributes[:pos] = fields[SYMBOL_TO_STRING[:pos]] || fields[:pos] attributes[:labels] = (fields[SYMBOL_TO_STRING[:labels]] || []).map { |lbl| Trello::Label.new(lbl) } attributes[:card_labels] = fields[SYMBOL_TO_STRING[:card_labels]] || fields[:card_labels] attributes[:last_activity_date] = Time.iso8601(fields[SYMBOL_TO_STRING[:last_activity_date]]) rescue nil attributes[:cover_image_id] = fields[SYMBOL_TO_STRING[:cover_image_id]] attributes[:badges] = fields[SYMBOL_TO_STRING[:badges]] attributes[:card_members] = fields[SYMBOL_TO_STRING[:card_members]] attributes[:source_card_id] = fields[SYMBOL_TO_STRING[:source_card_id]] || fields[:source_card_id] attributes[:source_card_properties] = fields[SYMBOL_TO_STRING[:source_card_properties]] || fields[:source_card_properties] self end |
#upvote ⇒ Object
Current authenticated user upvotes a card
367 368 369 370 371 372 373 374 375 376 377 |
# File 'lib/trello/card.rb', line 367 def upvote begin client.post("/cards/#{id}/membersVoted", { value: me.id }) rescue Trello::Error => e fail e unless e. =~ /has already voted/i end self end |
#valid? ⇒ Boolean
Is the record valid?
314 315 316 |
# File 'lib/trello/card.rb', line 314 def valid? name && list_id end |
#voters ⇒ Array<Trello::Member>
Returns a list of members who have upvoted this card NOTE: this fetches a list each time it’s called to avoid case where card is voted (or vote is removed) after card is fetched. Optimizing accuracy over network performance
236 237 238 |
# File 'lib/trello/card.rb', line 236 def voters Member.from_response client.get("/cards/#{id}/membersVoted") end |