From e01fd2d721450cdc9c2d4b4e209d57c3668d9eec Mon Sep 17 00:00:00 2001
From: Andrew Kvalheim <Andrew@Kvalhe.im>
Date: Thu, 27 Oct 2022 12:57:42 -0700
Subject: [PATCH] Add URLs to API responses

Resolves inability of API consumers to provide links to OSEM.
---
 app/serializers/conference_serializer.rb    | 8 +++++++-
 app/serializers/event_serializer.rb         | 7 ++++++-
 app/serializers/speaker_serializer.rb       | 7 ++++++-
 spec/serializers/event_serializer_spec.rb   | 2 ++
 spec/serializers/speaker_serializer_spec.rb | 2 ++
 spec/support/schemas/conference.json        | 4 ++++
 6 files changed, 27 insertions(+), 3 deletions(-)

diff --git a/app/serializers/conference_serializer.rb b/app/serializers/conference_serializer.rb
index 650dadf8..41eb2e28 100644
--- a/app/serializers/conference_serializer.rb
+++ b/app/serializers/conference_serializer.rb
@@ -2,7 +2,9 @@
 
 class ConferenceSerializer < ActiveModel::Serializer
   include ApplicationHelper
-  attributes :short_title, :title, :description, :start_date, :end_date, :picture_url,
+  include Rails.application.routes.url_helpers
+
+  attributes :short_title, :url, :title, :description, :start_date, :end_date, :picture_url,
              :difficulty_levels, :event_types, :rooms, :tracks,
              :date_range, :revision
 
@@ -56,6 +58,10 @@ class ConferenceSerializer < ActiveModel::Serializer
     end
   end
 
+  def url
+    url_for(object)
+  end
+
   def revision
     object.revision || 0
   end
diff --git a/app/serializers/event_serializer.rb b/app/serializers/event_serializer.rb
index 26d53801..a21aa57f 100644
--- a/app/serializers/event_serializer.rb
+++ b/app/serializers/event_serializer.rb
@@ -2,8 +2,13 @@
 
 class EventSerializer < ActiveModel::Serializer
   include ActionView::Helpers::TextHelper
+  include Rails.application.routes.url_helpers
 
-  attributes :guid, :title, :length, :scheduled_date, :language, :abstract, :speaker_ids, :type, :room, :track
+  attributes :guid, :url, :title, :length, :scheduled_date, :language, :abstract, :speaker_ids, :type, :room, :track
+
+  def url
+    conference_program_proposal_url(object.conference.short_title, object.id)
+  end
 
   def scheduled_date
     t = object.time
diff --git a/app/serializers/speaker_serializer.rb b/app/serializers/speaker_serializer.rb
index ee7e6dec..d0585fdf 100644
--- a/app/serializers/speaker_serializer.rb
+++ b/app/serializers/speaker_serializer.rb
@@ -2,8 +2,13 @@
 
 class SpeakerSerializer < ActiveModel::Serializer
   include ActionView::Helpers::TextHelper
+  include Rails.application.routes.url_helpers
 
-  attributes :name, :affiliation, :biography
+  attributes :url, :name, :affiliation, :biography
 
   delegate :name, to: :object
+
+  def url
+    url_for(object)
+  end
 end
diff --git a/spec/serializers/event_serializer_spec.rb b/spec/serializers/event_serializer_spec.rb
index 2b678319..b585e637 100644
--- a/spec/serializers/event_serializer_spec.rb
+++ b/spec/serializers/event_serializer_spec.rb
@@ -9,6 +9,7 @@ describe EventSerializer, type: :serializer do
     it 'sets guid, title, length, abstract and type' do
       expected_json = {
         guid:           event.guid,
+        url:            "http://localhost:3000/conferences/#{event.conference.short_title}/program/proposals/#{event.id}",
         title:          'Some Talk',
         length:         30,
         scheduled_date: '',
@@ -39,6 +40,7 @@ describe EventSerializer, type: :serializer do
     it 'sets guid, title, length, abstract, type, date, language, speakers, room and track' do
       expected_json = {
         guid:           event.guid,
+        url:            "http://localhost:3000/conferences/#{event.conference.short_title}/program/proposals/#{event.id}",
         title:          'Some Talk',
         length:         30,
         scheduled_date: ' 2014-03-04T09:00:00+0000 ',
diff --git a/spec/serializers/speaker_serializer_spec.rb b/spec/serializers/speaker_serializer_spec.rb
index 9174795e..e03adce5 100644
--- a/spec/serializers/speaker_serializer_spec.rb
+++ b/spec/serializers/speaker_serializer_spec.rb
@@ -8,6 +8,7 @@ describe SpeakerSerializer, type: :serializer do
   context 'speaker does not have biography' do
     it 'sets name and affiliation' do
       expected_json = {
+        url:         "http://localhost:3000/users/#{speaker.id}",
         name:        'John Doe',
         affiliation: 'JohnDoesInc',
         biography:   nil
@@ -22,6 +23,7 @@ describe SpeakerSerializer, type: :serializer do
 
     it 'sets name, affiliation and biography' do
       expected_json = {
+        url:         "http://localhost:3000/users/#{speaker.id}",
         name:        'John Doe',
         affiliation: 'JohnDoesInc',
         biography:   'Doest of all Jon Does'
diff --git a/spec/support/schemas/conference.json b/spec/support/schemas/conference.json
index 26e2c907..81fc1408 100644
--- a/spec/support/schemas/conference.json
+++ b/spec/support/schemas/conference.json
@@ -3,6 +3,7 @@
     "type" : "object",
     "required" : [
       "short_title",
+      "url",
       "title",
       "description",
       "start_date",
@@ -19,6 +20,9 @@
       "short_title": {
         "type": "string"
       },
+      "url": {
+        "type": "string"
+      },
       "title": {
         "type": "string"
       },