Skip to content

Pins API #2367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
svara merged 6 commits into from
Jan 27, 2026
+128 −3
Merged

Pins API #2367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1d8b765
Add JSON support for pin/unpin on the card endpoints and add tests.
svara Jan 14, 2026
e82dc08
Add JSON support for GET `/my/pins` with no pagination and tests.
svara Jan 14, 2026
90a7b15
Move pins scope into a variable. Keep web limit to 20 and set JSON to…
svara Jan 20, 2026
5384116
Rename the helper to user_pins and extract a pins_limit method.
svara Jan 22, 2026
8e24988
Add a new Pins section to docs/API.md covering pin/unpin and the pinn…
svara Jan 27, 2026
a75d56d
Merge branch 'main' into pins-api
Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions app/controllers/cards/pins_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,22 @@ def create
@pin = @card.pin_by Current.user

broadcast_add_pin_to_tray
render_pin_button_replacement

respond_to do |format|
format.turbo_stream { render_pin_button_replacement }
format.json { head :no_content }
end
end

def destroy
@pin = @card.unpin_by Current.user

broadcast_remove_pin_from_tray
render_pin_button_replacement

respond_to do |format|
format.turbo_stream { render_pin_button_replacement }
format.json { head :no_content }
end
end

private
Expand Down
11 changes: 10 additions & 1 deletion app/controllers/my/pins_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
class My::PinsController < ApplicationController
def index
@pins = Current.user.pins.includes(:card).ordered.limit(20)
@pins = user_pins
fresh_when etag: [ @pins, @pins.collect(&:card) ]
end

private
def user_pins
Current.user.pins.includes(:card).ordered.limit(pins_limit)
end

def pins_limit
request.format.json? ? 100 : 20
end
end
3 changes: 3 additions & 0 deletions app/views/my/pins/index.json.jbuilder
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
json.array! @pins do |pin|
json.partial! "cards/card", card: pin.card
end
73 changes: 73 additions & 0 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,6 +805,79 @@ __Response:__

Returns `204 No Content` on success.

## Pins

Pins let users keep quick access to important cards.

### `POST /:account_slug/cards/:card_number/pin`

Pins a card for the current user.

__Response:__

Returns `204 No Content` on success.

### `DELETE /:account_slug/cards/:card_number/pin`

Unpins a card for the current user.

__Response:__

Returns `204 No Content` on success.

### `GET /my/pins`

Returns the current user's pinned cards. This endpoint is not paginated and returns up to 100 cards.

__Response:__

```json
[
{
"id": "03f5vaeq985jlvwv3arl4srq2",
"number": 1,
"title": "First!",
"status": "published",
"description": "Hello, World!",
"description_html": "<div class=\"action-text-content\"><p>Hello, World!</p></div>",
"image_url": null,
"tags": ["programming"],
"golden": false,
"last_active_at": "2025-12-05T19:38:48.553Z",
"created_at": "2025-12-05T19:38:48.540Z",
"url": "http://fizzy.localhost:3006/897362094/cards/4",
"board": {
"id": "03f5v9zkft4hj9qq0lsn9ohcm",
"name": "Fizzy",
"all_access": true,
"created_at": "2025-12-05T19:36:35.534Z",
"url": "http://fizzy.localhost:3006/897362094/boards/03f5v9zkft4hj9qq0lsn9ohcm",
"creator": {
"id": "03f5v9zjw7pz8717a4no1h8a7",
"name": "David Heinemeier Hansson",
"role": "owner",
"active": true,
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7",
"avatar_url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7/avatar"
}
},
"creator": {
"id": "03f5v9zjw7pz8717a4no1h8a7",
"name": "David Heinemeier Hansson",
"role": "owner",
"active": true,
"email_address": "david@example.com",
"created_at": "2025-12-05T19:36:35.401Z",
"url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7",
"avatar_url": "http://fizzy.localhost:3006/897362094/users/03f5v9zjw7pz8717a4no1h8a7/avatar"
},
"comments_url": "http://fizzy.localhost:3006/897362094/cards/4/comments"
}
]
```

## Comments

Comments are attached to cards and support rich text.
Expand Down
22 changes: 22 additions & 0 deletions test/controllers/cards/pins_controller_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ class Cards::PinsControllerTest < ActionDispatch::IntegrationTest
assert_response :success
end

test "create as JSON" do
card = cards(:layout)

assert_not card.pinned_by?(users(:kevin))

post card_pin_path(card), as: :json

assert_response :no_content
assert card.reload.pinned_by?(users(:kevin))
end

test "destroy" do
assert_changes -> { cards(:shipping).pinned_by?(users(:kevin)) }, from: true, to: false do
perform_enqueued_jobs do
Expand All @@ -28,4 +39,15 @@ class Cards::PinsControllerTest < ActionDispatch::IntegrationTest

assert_response :success
end

test "destroy as JSON" do
card = cards(:shipping)

assert card.pinned_by?(users(:kevin))

delete card_pin_path(card), as: :json

assert_response :no_content
assert_not card.reload.pinned_by?(users(:kevin))
end
end
10 changes: 10 additions & 0 deletions test/controllers/my/pins_controller_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,14 @@ class My::PinsControllerTest < ActionDispatch::IntegrationTest
assert_response :success
assert_select "div", text: /#{users(:kevin).pins.first.card.title}/
end

test "index as JSON" do
expected_ids = users(:kevin).pins.ordered.pluck(:card_id)

get my_pins_path(format: :json)

assert_response :success
assert_equal expected_ids.count, @response.parsed_body.count
assert_equal expected_ids, @response.parsed_body.map { |card| card["id"] }
end
end