appolo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e8888ad31328cfd3892c4907b7cd9b61f88cec6
+  data.tar.gz: 97acaf885d74b45987699232f792668bd74a2aed
+SHA512:
+  metadata.gz: 1368bdd16eeeccdb9e933c25862fff49d7149be2e1f7ed2ceaae414c8be13310640eb72f2d1ade6bf15f47dc757018bcc352856e5d6691c22a1de1868595e7c9
+  data.tar.gz: 708ee79a4f4618cc39fa41b710efebc56f2f1561861bb084468e53d4da690b95721afb3cc7f7e7188b5deed0688fc9583a3387afaffb447b5c6821560fe147bb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.2
+
+sudo: required

data/Appolo.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'Appolo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "appolo"
+  spec.version       = Appolo::VERSION
+  spec.authors       = ["Pedro Gabriel"]
+  spec.email         = ["pedrogabriel@protonmail.ch"]
+
+  spec.summary       = %q{Provides easy access to Thoth web API}
+  spec.description   = %q{Ruby gem that provides quick and easy access to the web api of Thoth WebApp}
+  spec.homepage      = "https://github.com/CaptainGabriel/AppoloGem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rest-client"
+  spec.add_development_dependency "json"
+
+
+end

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in Appolo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+# Appolo
+[![Code Climate](https://codeclimate.com/github/CaptainGabriel/AppoloGem/badges/gpa.svg)](https://codeclimate.com/github/CaptainGabriel/AppoloGem)
+
+Ruby gem that provides quick and easy access to the web api of [Thoth WebApp](https://adeetc.thothapp.com)
+
+This project does not intends to show any super efficient or professional programming features since it´s only purpose was for me to learn the language and at the same time to build a ruby gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Appolo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install Appolo
+
+## Usage
+
+The following line of code
+
+```ruby
+puts Appolo::get_student_by_id 38209
+```
+
+will print the following info about a student with the id 38209:
+
+```
+Pedro Almeida - 38209
+```
+
+You can also get an instance related to the class with id 409 and
+afterwards all the lectures that were given there like this:
+
+```ruby
+some_class = Appolo.get_class_by_id 409
+all_lectures_now = some_class.lectures
+
+puts all_lectures[0].title
+# Aula 01 Introdução às  VMs processo e comparação .Net vs JVM
+puts all_lectures[1].title
+# Aula 02 Distribuição e ligação de componetes em ambiente Unmanaged
+puts all_lectures[2].title
+# Aula 03 Características da distribuição e ligação de componentes Managed
+```
+
+To get all the students participating in a certain class:
+
+```ruby
+some_class = Appolo.get_class_by_id 409
+participants = some_class.participants
+
+puts participants[0].name
+# Humberto Pedro Pinto da Silva
+```
+
+For more information, just grab the id and get the specific student
+```ruby
+id = participants[0].id
+student = Appolo.get_student_by_id id
+puts student.short_name
+# Humberto Silva
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/CaptainGabriel/Appolo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+#will enable us (manually) or Guard to execute the task and run the RSpec test suite
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec
+
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "Appolo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/example.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require 'Appolo'
+
+def any_key
+  puts '<<any key to continue>>'
+  gets
+end
+
+puts 'This program shows how this gem can be used by you.'
+
+any_key
+
+puts 'To start, let\'s get one student.'
+puts 'We can get students by their ID so let\'s use the ID \'38209\':'
+any_key
+puts 'You can type \'puts Appolo::get_student_by_id 38209\' and we get:'
+puts '<<' + Appolo.get_student_by_id(38209).to_s + '>>'
+any_key
+
+puts 'Now, let\'s get some teachers at once.'
+puts 'You can do it by typing \'Appolo::get_teachers.each {|teacher| puts teacher}\''
+puts 'and you will see something like:'
+puts '1 - Carlos Guedes : cguedes@cc.isel.ipl.pt'
+puts '2 - Ezequiel Conde : ezeq@cc.isel.ipl.pt'
+puts '3 - Miguel Gamboa Carvalho : mcarvalho@cc.isel.ipl.pt'
+puts '...'
+any_key
+
+puts 'Simple, right ? :)'

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/Appolo/Models/avatar_url.rb

@@ -0,0 +1,13 @@
+
+class AvatarUrl
+
+    attr_reader :size_24, :size_32, :size_64, :size_128
+
+
+    def initialize(avatar_json_object)
+        @size_24 = avatar_json_object['size24']
+        @size_32 = avatar_json_object['size32']
+        @size_64 = avatar_json_object['size64']
+        @size_128 = avatar_json_object['size128']
+    end
+end

data/lib/Appolo/Models/lecture.rb

@@ -0,0 +1,30 @@
+require_relative '../../../lib/Appolo/Models/model_utils'
+require 'json'
+require 'rest-client'
+
+##
+# This class represents a lecture given at some point in some class.
+class Lecture
+
+  attr_reader :id, :content, :date_created, :title
+
+  ##
+  # Create an instance of Lecture based upon +json_str+
+  # that can be an hash or a JSON string.
+  def initialize (json_str)
+    json_data = Appolo.check_json_info json_str
+
+    @id = json_data[ModelUtils::ID]
+    @content = json_data[ModelUtils::CONTENT]
+    @date_created = json_data[ModelUtils::CREATED_WHEN]
+    @title = json_data[ModelUtils::TITLE]
+
+  end
+
+  ##
+  # String representation of a Lecture object.
+  def to_s
+    "#{@id} - #{@title} : #{@date_created}"
+  end
+
+end

data/lib/Appolo/Models/links.rb

@@ -0,0 +1,28 @@
+require_relative 'model_utils'
+
+class Links
+
+    attr_reader :self, :root, :type, :main_teacher, :course_unit,
+                :lective_semester, :classes, :pages, :participants,
+                :groups, :lectures, :news_items, :work_items, :resources
+
+
+    def initialize(links, tpe)
+        @self = links[ModelUtils::SELF]
+        @root = links[ModelUtils::ROOT]
+        @type = links[tpe]
+
+        @main_teacher = links[ModelUtils::MAIN_TEACHER]
+        @course_unit = links[ModelUtils::COURSE_UNIT]
+        @lective_semester = links[ModelUtils::LECTIVE_SEMESTER]
+        @classes = links[ModelUtils::CLASSES]
+        @pages = links[ModelUtils::PAGES]
+        @participants = links[ModelUtils::PARTICIPANTS]
+        @groups = links[ModelUtils::GROUPS]
+        @lectures = links[ModelUtils::LECTURES]
+        @news_items = links[ModelUtils::NEWS_ITEMS]
+        @work_items = links[ModelUtils::WORK_ITEMS]
+        @resources = links[ModelUtils::RESOURCES]
+
+    end
+end

data/lib/Appolo/Models/main_model/classes.rb

@@ -0,0 +1,87 @@
+require 'json'
+require 'rest-client'
+require_relative '../../Models/model_utils'
+require_relative '../../Models/links'
+require_relative '../../Models/avatar_url'
+require_relative '../../Models/lecture'
+require_relative '../../Models/resource'
+require_relative 'program'
+
+class Classes
+
+  TYPE = 'classes'
+
+  attr_reader :id, :full_name, :course_unit_short_name, :class_name, :main_teacher_short_name
+  attr_reader :course_unit_id, :lective_semester_id, :main_teacher_id, :max_group_size
+  attr_reader :main_teacher, :links
+
+  ##
+  # Initiate an instance of Classes based upon +json_info*
+  # that can be an hash or a JSON string.
+  def initialize(json_info)
+    json_data = ModelUtils::check_json_info json_info
+
+    @id = json_data[ModelUtils::ID]
+    @full_name = json_data[ModelUtils::FULL_NAME]
+    @course_unit_short_name = json_data[ModelUtils::COURSE_UNIT_SHORT_NAME]
+    @class_name = json_data[ModelUtils::CLASS_NAME]
+    @main_teacher_short_name = json_data[ModelUtils::MAIN_TEACHER_SHORT_NAME]
+    @course_unit_id = json_data[ModelUtils::COURSE_UNIT_ID]
+    @lective_semester_id = json_data[ModelUtils::LECTIVE_SEMESTER_ID]
+    @main_teacher_id = json_data[ModelUtils::MAIN_TEACHER_ID]
+    @max_group_size = json_data[ModelUtils::MAX_GROUP_SIZE]
+
+    teacher_self_link = json_data[ModelUtils::LINKS]
+    teacher_self_link = teacher_self_link[ModelUtils::MAIN_TEACHER]
+    unless teacher_self_link.nil?
+      #TODO get the id and check if a request has been made in the past
+      teacher_self_response = RestClient.get teacher_self_link
+      @main_teacher = Teacher.new teacher_self_response
+    end
+
+    @links = Links.new(json_data[ModelUtils::LINKS], TYPE)
+  end
+
+  ##
+  # Small representation of the Classes object
+  def to_s
+    "#{@id} - #{@full_name} - #{@main_teacher_short_name}"
+  end
+
+  ##
+  # Returns all the students related to this class.
+  def participants
+    response_all_participants = RestClient.get @links.participants
+    all_participants = JSON.parse response_all_participants
+    temp = []
+    all_participants['students'].each do |participant|
+      temp.push Student.new participant
+    end
+    temp
+  end
+
+  ##
+  # Returns all the lectures related to this class.
+  def lectures
+    response_all_lectures = RestClient.get @links.lectures
+    all_lectures = JSON.parse response_all_lectures
+    temp = []
+    all_lectures['classLectures'].each do |lecture|
+      temp.push Lecture.new lecture
+    end
+    temp
+  end
+
+  ##
+  # Returns all the resources related to a certain class.
+  def resources
+    response_all_resources = RestClient.get @links.resources
+    all_resources = JSON.parse response_all_resources
+    temp = []
+    all_resources['classResources'].each do |resource|
+      temp.push Resource.new resource
+    end
+    temp
+  end
+
+end

data/lib/Appolo/Models/main_model/courses.rb

@@ -0,0 +1,20 @@
+class CourseUnit
+    private
+    TYPE = 'courseunits'
+
+    public
+    attr_reader :id,  :short_name, :name
+    attr_reader :programs, :links
+
+    def initialize(json_info)
+        @id = json_info[ModelUtils::ID]
+        @short_name = json_info[ModelUtils::SHORT_NAME]
+        @name = json_info[ModelUtils::NAME]
+        @links = Links.new json_info[ModelUtils::LINKS], TYPE
+        #@programs = TODO
+    end
+
+    def to_s
+        "#{@id} - #{@short_name}"
+    end
+end

data/lib/Appolo/Models/main_model/lective_semester.rb

@@ -0,0 +1,29 @@
+require_relative '../../Models/model_utils'
+require_relative '../../Models/links'
+
+class LectiveSemester
+
+  attr_reader :lective_semester_id, :short_name, :start_year, :term, :term_name
+  attr_reader :links
+
+  TYPE = 'lectiveSemesters'
+
+  def initialize(json_str)
+    if json_str.is_a? Hash
+      json_data = json_str
+    else
+      json_data = JSON.parse json_str
+    end
+
+    @lective_semester_id = json_data[ModelUtils::LECTIVE_ID]
+    @short_name = json_data[ModelUtils::SHORT_NAME]
+    @start_year = json_data[ModelUtils::START_YEAR]
+    @term = json_data[ModelUtils::TERM]
+    @term_name = json_data[ModelUtils::TERM_NAME]
+    @links = Links.new json_data[ModelUtils::LINKS], TYPE
+  end
+
+  def to_s
+    "#{@lective_semester_id} - #{@short_name} : #{@term_name} #{@start_year}"
+  end
+end

data/lib/Appolo/Models/main_model/program.rb

@@ -0,0 +1,20 @@
+require_relative '../../Models/model_utils'
+require_relative '../../Models/links'
+class Program
+
+
+    attr_reader :id, :short_name, :links, :full_name
+
+    TYPE = 'programs'
+
+    def initialize(program_json_struct, links_tpe=TYPE)
+        @id = program_json_struct[ModelUtils::ID]
+        @short_name = program_json_struct[ModelUtils::SHORT_NAME]
+        @links = Links.new(program_json_struct[ModelUtils::LINKS], links_tpe)
+        @full_name = program_json_struct[ModelUtils::FULL_NAME]
+    end
+
+    def to_s
+        "#{@id} -  #{@full_name}"
+    end
+end

data/lib/Appolo/Models/main_model/student.rb

@@ -0,0 +1,34 @@
+require 'json'
+require_relative '../../Models/model_utils'
+require_relative '../../Models/links'
+require_relative '../../Models/avatar_url'
+require_relative 'program'
+
+class Student
+
+  TYPE = 'students'
+
+  attr_reader :id, :number, :short_name, :name, :academic_email, :github_username
+  attr_reader :avatar_url, :program, :links , :students
+
+  def initialize(json_str)
+    json_data = Appolo.check_json_info json_str
+
+    @id = json_data[ModelUtils::ID]
+    @number = json_data[ModelUtils::NUMBER]
+    @short_name = json_data[ModelUtils::SHORT_NAME]
+    @name = json_data[ModelUtils::NAME] || json_data[ModelUtils::FULL_NAME]
+    @academic_email = json_data[ModelUtils::ACADEMIC_EMAIL]
+    @github_username = json_data[ModelUtils::GITHUB_USERNAME]
+
+    program_info = json_data[ModelUtils::PROGRAM]
+    @program = Program.new(program_info, TYPE) unless program_info.nil?
+    @avatar_url = AvatarUrl.new(json_data[ModelUtils::AVATAR_URL])
+    @links = Links.new(json_data[ModelUtils::LINKS], TYPE)
+  end
+
+  def to_s
+    "#{@short_name} - Number #{@number.to_s}"
+  end
+
+end

data/lib/Appolo/Models/main_model/teacher.rb

@@ -0,0 +1,33 @@
+require 'json'
+require_relative '../../Models/links'
+
+class Teacher
+
+  TYPE = 'teachers'
+
+  attr_reader :id, :number, :short_name, :name, :academic_email
+  attr_reader :avatar_url, :links
+
+
+  def initialize(json_info)
+      if json_info.is_a? Hash
+        json_data = json_info
+      else
+        json_data = JSON.parse json_info
+      end
+
+      @id = json_data[ModelUtils::ID]
+      @number = json_data[ModelUtils::NUMBER]
+      @short_name = json_data[ModelUtils::SHORT_NAME]
+      @name = json_data[ModelUtils::NAME]
+      @academic_email = json_data[ModelUtils::ACADEMIC_EMAIL]
+      @links = Links.new(json_data[ModelUtils::LINKS], TYPE)
+      @avatar_url = AvatarUrl.new(json_data[ModelUtils::AVATAR_URL])
+
+  end
+
+
+  def to_s
+    "#{@id} - #{@short_name} : #{@academic_email}"
+  end
+end

data/lib/Appolo/Models/model_utils.rb

@@ -0,0 +1,59 @@
+module ModelUtils
+
+  NAME = 'name'
+  SHORT_NAME = 'shortName'
+  ID = 'id'
+  NUMBER = 'number'
+  GITHUB_USERNAME = 'gitHubUsername'
+  ACADEMIC_EMAIL = 'academicEmail'
+  AVATAR_URL = 'avatarUrl'
+  LINKS = '_links'
+
+  SELF = 'self'
+  ROOT = 'root'
+  PROGRAM = 'program'
+
+  FULL_NAME = 'fullName'
+  COURSE_UNIT_SHORT_NAME = 'courseUnitShortName'
+  LECTIVE_SEMESTER_SHORT_NAME = 'lectiveSemesterShortName'
+  LECTIVE_SEMESTER = 'lectiveSemester'
+  CLASS_NAME = 'className'
+  CLASSES = 'classes'
+  CLASS_ID = 'classId'
+  MAIN_TEACHER_SHORT_NAME = 'mainTeacherShortName'
+  COURSE_UNIT_ID = 'courseUnitId'
+  COURSE_UNIT = 'courseUnit'
+  LECTIVE_SEMESTER_ID = 'lectiveSemesterId'
+  MAIN_TEACHER_ID = 'mainTeacherId'
+  MAX_GROUP_SIZE = 'maxGroupSize'
+  MAIN_TEACHER = 'mainTeacher'
+
+  LECTIVE_ID = 'lectiveSemesterId'
+  START_YEAR = 'startYear'
+  TERM = 'term'
+  TERM_NAME = 'termName'
+  OTHER_TEACHERS = 'otherTeachers'
+  PAGES = 'pages'
+  PARTICIPANTS = 'participants'
+  GROUPS = 'groups'
+  LECTURES = 'lectures'
+  NEWS_ITEMS = 'newsItems'
+  WORK_ITEMS = 'workItems'
+  RESOURCES = 'resources'
+
+  CONTENT = 'content'
+  DATE_CREATED = 'dateCreated'
+  CREATED_WHEN = 'when'
+  TITLE = 'title'
+  DESCRIPTION = 'description'
+
+  def self.check_json_info(json_info)
+    if json_info.is_a? Hash
+      json_data = json_info
+    else
+      json_data = JSON.parse json_info
+    end
+    json_data
+  end
+
+end

data/lib/Appolo/Models/resource.rb

@@ -0,0 +1,23 @@
+require_relative 'links'
+require_relative 'model_utils'
+
+class Resource
+
+  attr_reader :id, :description, :class_id, :title
+  attr_reader :links
+
+  def initialize(json_str)
+    json_data = ModelUtils::check_json_info json_str
+    
+    @id = json_data[ModelUtils::ID]
+    @description = json_data[ModelUtils::DESCRIPTION]
+    @class_id = json_data[ModelUtils::CLASS_ID]
+    @title = json_data[ModelUtils::TITLE]
+    @links = Links.new json_data[ModelUtils::LINKS], 'resources'
+  end
+
+  def to_s
+    "Resource : #{@class_id} - #{@title}"
+  end
+
+end

data/lib/Appolo/version.rb

@@ -0,0 +1,3 @@
+module Appolo
+  VERSION = "1.0.0"
+end

data/lib/Appolo.rb

@@ -0,0 +1,216 @@
+require 'Appolo/version'
+require 'rest-client'
+require_relative '../lib/Appolo/Models/main_model/student'
+require_relative '../lib/Appolo/Models/main_model/teacher'
+require_relative '../lib/Appolo/Models/main_model/classes'
+require_relative '../lib/Appolo/Models/main_model/program'
+require_relative '../lib/Appolo/Models/main_model/courses'
+require_relative '../lib/Appolo/Models/main_model/lective_semester'
+require_relative '../lib/Appolo/Models/lecture'
+require 'json'
+
+##
+# This module is the main provider for the public API that
+# this gem contains.
+
+module Appolo
+
+  private
+
+  COURSES_API_CODENAME = 'courseUnits'
+  TEACHERS_API_CODENAME = 'teachers'
+  STUDENTS_API_CODENAME = 'students'
+  CLASSES_API_CODENAME =  'classes'
+  PROGRAMS_API_CODENAME = 'programs'
+  LECTIVESEM_API_CODENAME = 'lectiveSemesters'
+
+  $all_students = Hash.new
+  $all_teachers = Hash.new
+  $all_classes = Hash.new
+  $all_programs = Hash.new
+  $all_courses = Hash.new
+  $all_lective_sem = Hash.new
+
+  #main API links
+  TEACHERS_API_LINK = 'https://adeetc.thothapp.com/api/v1/teachers/'
+  STUDENTS_API_LINK = 'https://adeetc.thothapp.com/api/v1/students/'
+  CLASSES_API_LINK = 'https://adeetc.thothapp.com/api/v1/classes/'
+  PROGRAMS_API_LINK = 'https://adeetc.thothapp.com/api/v1/programs/'
+  COURSES_API_LINK = 'https://adeetc.thothapp.com/api/v1/courseunits/'
+  LECTIVE_SEMESTERS_API_LINK = 'https://adeetc.thothapp.com/api/v1/lectivesemesters'
+
+  
+  def self.verify_response(resp)
+    (resp.code == 200) ? resp : nil
+  end
+
+  def self.check_json_info(json_str)
+    unless json_str.is_a? Hash
+      JSON.parse json_str
+    else
+      json_str
+    end
+  end
+
+  public
+
+  ##
+  #Returns an array of Student instances based upon the main API link.
+  
+  def self.get_students
+    return $all_students unless $all_students.length == 0
+    begin
+      response = RestClient.get STUDENTS_API_LINK
+      valid_resp = verify_response response
+      students_temp = JSON.parse(valid_resp)[STUDENTS_API_CODENAME]
+      students_temp.each do |student|
+        stub = Student.new(student)
+        $all_students[stub.id] = stub
+      end
+      $all_students
+    rescue => e
+      nil #TODO - exceptions
+    end
+  end
+
+  
+  ##
+  #Returns an array of Teacher instances based upon the main API link.
+    
+  def self.get_teachers
+    return $all_teachers unless $all_teachers.length == 0
+    begin
+      response = RestClient.get TEACHERS_API_LINK
+      valid_response = verify_response response
+      teachers_temp = JSON.parse(valid_response)[TEACHERS_API_CODENAME]
+      teachers_temp.each do |teacher|
+        stub = Teacher.new(teacher)
+        $all_teachers[stub.id] = stub
+      end
+      $all_teachers
+    rescue => e
+      nil
+    end
+  end
+
+
+  ##
+  # Returns an array of Program instances based upon the main API link.
+  
+  def self.get_programs
+    return $all_programs unless $all_programs.length == 0
+    begin
+      response = RestClient.get PROGRAMS_API_LINK
+      valid_resp = verify_response response
+      programs_temp = JSON.parse(valid_resp)[PROGRAMS_API_CODENAME]
+      programs_temp.each do |program|
+        stub = Program.new program
+        $all_programs[stub.id] = stub
+      end
+      $all_programs
+    rescue => e
+      nil
+    end
+  end
+
+
+  ##
+  # Returns an array of CourseUnit instances based upon the main API link.
+
+  def self.get_courses
+    return $all_courses unless $all_courses.length == 0
+    begin
+      response = RestClient.get COURSES_API_LINK
+      valid_resp = verify_response response #debug
+      courses_temp = JSON.parse(valid_resp)[COURSES_API_CODENAME]
+      courses_temp.each do |course|
+        stub = CourseUnit.new course
+        $all_courses[stub.id] = stub
+      end
+      $all_courses
+    rescue => e
+      nil
+    end
+  end
+
+
+  ##
+  # Returns an array of LectiveSemester instances based upon the main API link.
+
+  def self.get_lective_semesters
+    return $all_lective_sem unless $all_lective_sem.length == 0
+    begin
+      response = RestClient.get LECTIVE_SEMESTERS_API_LINK
+      valid_resp = verify_response response
+      lective_temp = JSON.parse(valid_resp)[LECTIVESEM_API_CODENAME]
+      lective_temp.each do |lec_sem|
+        stub = LectiveSemester.new lec_sem
+        $all_lective_sem[stub.lective_semester_id] = stub
+      end
+      $all_lective_sem
+    rescue => e
+      nil
+    end
+  end
+
+
+  ##
+  # Returns an array of Classes instances based upon the main API link.
+
+  def self.get_classes
+    return $all_classes unless $all_classes.length == 0
+    begin
+      response = RestClient.get CLASSES_API_LINK
+      valid_resp = verify_response response
+      classes_temp = JSON.parse(valid_resp)[CLASSES_API_CODENAME]
+      classes_temp.each do |classe|
+        stub = Classes.new classe
+        $all_classes[stub.id] = stub
+      end
+      $all_classes
+    rescue => e
+      nil
+    end
+  end
+
+  ##
+  # Return a single instance of Teacher based upon the +id+ given.
+
+  def self.get_teacher_by_id(id)
+    begin
+      response = RestClient.get TEACHERS_API_LINK + id.to_s
+      Teacher.new (verify_response response)
+    rescue => e
+      nil
+    end
+  end
+
+  
+  ##
+  # Return a single instance of Classes based upon the +id+ given.
+
+  def self.get_class_by_id(id)
+    begin
+      response = RestClient.get CLASSES_API_LINK + id.to_s
+      Classes.new (verify_response response)
+    rescue => e
+      nil
+    end
+  end
+
+  ##
+  # Return a single instance of Student based upon the +id+ given.
+
+  def self.get_student_by_id(id)
+    return $all_students[id] unless $all_students.count == 0
+    begin
+      response = RestClient.get STUDENTS_API_LINK + id.to_s
+      Student.new (verify_response response)
+    rescue => e
+      nil
+    end
+  end
+
+    
+
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: appolo
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pedro Gabriel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem that provides quick and easy access to the web api of Thoth
+  WebApp
+email:
+- pedrogabriel@protonmail.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Appolo.gemspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/example.rb
+- bin/setup
+- lib/Appolo.rb
+- lib/Appolo/Models/avatar_url.rb
+- lib/Appolo/Models/lecture.rb
+- lib/Appolo/Models/links.rb
+- lib/Appolo/Models/main_model/classes.rb
+- lib/Appolo/Models/main_model/courses.rb
+- lib/Appolo/Models/main_model/lective_semester.rb
+- lib/Appolo/Models/main_model/program.rb
+- lib/Appolo/Models/main_model/student.rb
+- lib/Appolo/Models/main_model/teacher.rb
+- lib/Appolo/Models/model_utils.rb
+- lib/Appolo/Models/resource.rb
+- lib/Appolo/version.rb
+homepage: https://github.com/CaptainGabriel/AppoloGem
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Provides easy access to Thoth web API
+test_files: []