From 8866e29a4407af0e7a51dbd274f08bb9b9d30bb4 Mon Sep 17 00:00:00 2001
From: Tobias Eidelpes <tobias@eidelpes.info>
Date: Sun, 10 May 2020 17:10:21 +0200
Subject: [PATCH] Add comments for lecturer name feature

---
 app/controllers/courses_crawler_controller.rb | 2 ++
 lib/tiss/tiss_crawler.rb                      | 2 ++
 2 files changed, 4 insertions(+)

diff --git a/app/controllers/courses_crawler_controller.rb b/app/controllers/courses_crawler_controller.rb
index ab2dc80..7e4a342 100644
--- a/app/controllers/courses_crawler_controller.rb
+++ b/app/controllers/courses_crawler_controller.rb
@@ -23,11 +23,13 @@ class CoursesCrawlerController < TissCrawlerController
     @course = TissCrawler.get_course_details(params)
     puts @course
 
+    # Get all the org ids into one array
     @lecturers_oid = @course['lecturers']['oid']
     @lecturers_names = []
 
     if @lecturers_oid != nil
       @lecturers_oid.each do |item|
+        # For each org id get the associated name
         puts TissCrawler.get_oid_name(item)
         @lecturers_names << (TissCrawler.get_oid_name(item))
       end
diff --git a/lib/tiss/tiss_crawler.rb b/lib/tiss/tiss_crawler.rb
index 6a6f3d2..c402b54 100644
--- a/lib/tiss/tiss_crawler.rb
+++ b/lib/tiss/tiss_crawler.rb
@@ -41,6 +41,8 @@ class TissCrawler
   end
 
   def self.get_oid_name(item)
+    # Fetches a person's name based on the org id
+    # Example: https://tiss.tuwien.ac.at/api/person/v22/oid/250197
     api = '/api/person/v22/oid/'
     url = $host + api + item
     puts(url)