appolo 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecc284a43e5df985d8dc112580091bbf85f59bb7
-  data.tar.gz: 78fbd70effa5701950d40863f8e732349012700a
+  metadata.gz: 5d6f5d7cf36b6b63bd48ef55d6f39ccf372fda45
+  data.tar.gz: db2e520a27f22384907daf918ee94c5318f7e35d
 SHA512:
-  metadata.gz: f4ba4b2b85bf5fa7765bf71e8848cca7e15e468c07efbb718a3fc0110c6c2e0811ef6e14fefa98e68069473d547bfe65d85c1cbc9859994f0c0cafe734afd3c5
-  data.tar.gz: c1965a86e1dd129fbc52b7e9dd5f6deca8b41fdd2bd028d8ddf5f0e4351f28d09f98d4f2081e03232ec679804c6fefa42a2aca37b9215dc644e7b0076a7878f2
+  metadata.gz: 3e82c51ff707d454a815571ff4f1107bdde56d1100aa10f90f5e93750a9065861b5caf8032c0e28aae55fb675a887eef67dfa1b93ceb76b390c2ea4258c6150a
+  data.tar.gz: 1ce9eb4e2aec62595ac51974158ba15c9b8810cacae09436ad54a00a4aec24cc4f7c9a457c3f468ed39a3b6e581abcaaf802690f89eaf0b15953dde9ac6e6d08

data/Appolo.gemspec

@@ -26,6 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rest-client', '~> 1.8', '>= 1.8.0'
   spec.add_development_dependency 'json', '~> 1.8', '>= 1.8.3'
-
+  spec.add_development_dependency 'parallel', '~> 1.6.1'
 
 end

data/lib/Appolo/Models/element.rb

@@ -12,7 +12,16 @@ class Element
   def initialize (id, s_name, links, type_for_links)
     @id = id
     @short_name = s_name
-    @links = Links.new(links, type_for_links)
+    @links = Links.new(links, type_for_links) unless links.nil?
+  end
+
+  def 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/main_model/classes.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'rest-client'
+require 'parallel'
 require_relative '../model_utils'
 require_relative '../secondary/links'
 require_relative '../secondary/avatar_url'
@@ -19,7 +20,7 @@ class Classes < Element
   # 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
+    json_data = check_json_info json_info
 
     super(json_data[ModelUtils::ID], 
           json_data[ModelUtils::CLASS_NAME], 
@@ -69,9 +70,9 @@ class Classes < Element
     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 = Parallel.each(all_lectures['classLectures'], :in_processes => 1){
+        |lecture| temp.push Lecture.new lecture
+    }
     temp
   end
 
@@ -81,9 +82,9 @@ class Classes < Element
     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 = Parallel.each(all_resources['classResources'], :in_processes => 1){
+      |resource| temp.push Resource.new resource
+    }
     temp
   end
 

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

@@ -8,11 +8,14 @@ class CourseUnit < Element
   attr_reader :name, :programs
 
   def initialize(json_info)
-    super(json_info[ModelUtils::ID],
-          json_info[ModelUtils::SHORT_NAME],
-          json_info[ModelUtils::LINKS],
+
+    json_data = check_json_info json_info
+
+    super(json_data[ModelUtils::ID],
+          json_data[ModelUtils::SHORT_NAME],
+          json_data[ModelUtils::LINKS],
           @@type_of_links)
-    @name = json_info[ModelUtils::NAME]
+    @name = json_data[ModelUtils::NAME]
 
     #@programs = TODO
   end

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

@@ -9,7 +9,7 @@ class LectiveSemester < Element
   @@type_of_links = 'lectiveSemesters'
 
   def initialize(json_str)
-    json_data = ModelUtils.check_json_info json_str
+    json_data = check_json_info json_str
 
     super(json_data[ModelUtils::LECTIVE_ID],
           json_data[ModelUtils::SHORT_NAME],

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

@@ -9,7 +9,8 @@ class Program < Element
   @@type_for_links = 'programs'
 
   def initialize(data)
-    json_data = ModelUtils::check_json_info data
+    json_data = check_json_info data
+
 
     super(json_data[ModelUtils::ID],
           json_data[ModelUtils::SHORT_NAME],

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

@@ -17,7 +17,7 @@ class Student < Element
       return
     end
 
-    json_data = Appolo.check_json_info json_str
+    json_data = check_json_info json_str
 
     super(json_data[ModelUtils::ID],
           json_data[ModelUtils::SHORT_NAME],

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

@@ -11,7 +11,7 @@ class Teacher < Element
 
 
   def initialize(json_info)
-    json_data = Appolo.check_json_info json_info
+    json_data = check_json_info json_info
 
     super(json_data[ModelUtils::ID],
           json_data[ModelUtils::SHORT_NAME],
@@ -24,7 +24,6 @@ class Teacher < Element
     @avatar_url = AvatarUrl.new(json_data[ModelUtils::AVATAR_URL])
   end
 
-
   def to_s
     "#{@id} - #{@short_name} : #{@academic_email}"
   end

data/lib/Appolo/Models/model_utils.rb

@@ -47,13 +47,6 @@ module ModelUtils
   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/secondary/lecture.rb

@@ -1,20 +1,21 @@
 require_relative '../model_utils'
+require_relative '../element'
 require 'json'
 require 'rest-client'
 
 ##
 # This class represents a lecture given at some point in some class.
-class Lecture
+class Lecture < Element
 
-  attr_reader :id, :content, :date_created, :title
+  attr_reader :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
+    json_data = check_json_info json_str
 
-    @id = json_data[ModelUtils::ID]
+    super(json_data[ModelUtils::ID],nil,nil,nil)
     @content = json_data[ModelUtils::CONTENT]
     @date_created = json_data[ModelUtils::CREATED_WHEN]
     @title = json_data[ModelUtils::TITLE]

data/lib/Appolo/Models/secondary/resource.rb

@@ -1,19 +1,23 @@
 require_relative 'links'
 require_relative '../model_utils'
 
-class Resource
+class Resource < Element
 
-  attr_reader :id, :description, :class_id, :title
-  attr_reader :links
+  @@type_of_links = 'resources'
+
+  attr_reader :description, :class_id, :title
 
   def initialize(json_str)
-    json_data = ModelUtils::check_json_info json_str
-    
-    @id = json_data[ModelUtils::ID]
+    json_data = check_json_info json_str
+
+    super(json_data[ModelUtils::ID],
+          nil,
+          json_data[ModelUtils::LINKS],
+          @@type_of_links)
+
     @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

data/lib/Appolo/version.rb

@@ -1,3 +1,3 @@
 module Appolo
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

data/lib/Appolo.rb

@@ -26,7 +26,7 @@ module Appolo
 
   ##
   # This hash contains each hash structure that contains the different
-  # elements after being requested by the method Appolo#get_set_of_elements
+  # elements after being requested by the method Appolo#get_set_of_elements.
   Elements = {
       :students => $all_students,
       :teachers => $all_teachers,
@@ -49,9 +49,14 @@ module Appolo
       :programs => 'https://adeetc.thothapp.com/api/v1/programs/',
       :courses  => 'https://adeetc.thothapp.com/api/v1/courseunits/',
       :lec_semesters => 'https://adeetc.thothapp.com/api/v1/lectivesemesters'
-
   }
 
+  ##
+  # In order to build the hash of Link objects,
+  # each class must have a codename to append later
+  # during the construction. Since I dont believe in
+  # magical strings, I've putted all of those in here.
+
   Api_Codename = {
       :students => 'students',
       :teachers => 'teachers',
@@ -78,15 +83,62 @@ module Appolo
     Result.new(result, error)
   end
 
+  ##
+  # This hash contains the procs that build and populate the hashes
+  # that contain all the objects from the last made request.
+  # So, when we request all the students, the proc related to the symbol
+  # ":student" will be used to create the instances and insert them into the hash.
+
   Builder_Elements = {
-      students: lambda{|students| students.each{|student| stub , $all_students[stub.id] = Student.new(student), stub}},
-      teachers: lambda{|teachers| teachers.each{|teacher| stub, $all_teachers[stub.id] = Teacher.new(teacher), stub }},
-      classes: lambda{|classes| classes.each{|classe| stub, $all_classes[stub.id] = Classes.new(classe), stub}},
-      programs: lambda{|programs| programs.each{|program| stub, $all_programs[stub.id] = Program.new(program), stub}},
-      courses: lambda{|courses| courses.each{|course| stub, $all_courses[stub.id] = CourseUnit.new(course), stub}},
-      lec_semesters: lambda{|semesters| semesters.each{|lec_sem| stub, $all_lective_sem[stub.id] = LectiveSemester.new(lec_sem), stub}}
+      students: lambda{
+          |students| students.each_with_index {
+            |student, idx|
+              stub = Student.new(student)
+              $all_students[idx] = stub
+            }
+      },
+      teachers: lambda{
+          |teachers| teachers.each_with_index {
+            |teacher, idx|
+              stub = Teacher.new(teacher)
+              $all_teachers[idx] =stub
+          }
+      },
+      classes: lambda{
+          |classes| classes.each_with_index{
+            |classe, idx|
+              stub = Classes.new(classe)
+              $all_classes[idx] = stub
+          }
+      },
+      programs: lambda{
+          |programs| programs.each_with_index{
+            |program, idx|
+              stub = Program.new(program)
+              $all_programs[idx] = stub
+          }
+      },
+      courses: lambda{
+          |courses| courses.each_with_index{
+            |course, idx|
+              stub = CourseUnit.new(course)
+              $all_courses[idx] = stub
+          }
+      },
+      lec_semesters: lambda{
+          |semesters| semesters.each_with_index{
+            |lec_sem, idx|
+              stub = LectiveSemester.new(lec_sem)
+              $all_lective_sem[idx] = stub
+          }
+      }
   }
 
+  ##
+  # This hash acts the same as Builder_Elements but instead of creating
+  # a set of elements, it creates only one since its purpose is to be used
+  # when the method Appolo#get_element_by_id is called.
+
   Builder_Element = {
       students: lambda{|data| Student.new(verify_response data)},
       teachers: lambda{|data| Teacher.new(verify_response data)},
@@ -99,7 +151,14 @@ module Appolo
   public
 
   ##
-  #
+  # Call this method in order to get an array of elements.
+  # To specify which element to search you must specify +element_name+ as:
+  # * :students -> Set of Students
+  # * :teachers -> Set of Teachers
+  # * :classes  -> Set of Classes
+  # * :programs -> Set of Programs
+  # * :courses  -> Set of Courses
+  # * :lec_semesters -> Set of Lective Semesters
 
   def self.get_set_of_elements(element_name)
     return Elements[element_name] unless Elements[element_name].length == 0
@@ -116,6 +175,19 @@ module Appolo
     end
   end
 
+  ##
+  # Call this method in order to get a single element.
+  # To specify which element to search you must specify +element_name+ as:
+  # * :students -> Set of Students
+  # * :teachers -> Set of Teachers
+  # * :classes  -> Set of Classes
+  # * :programs -> Set of Programs
+  # * :courses  -> Set of Courses
+  # * :lec_semesters -> Set of Lective Semesters
+  #
+  # The +id+ specifies the *id* related to the element inside the Thoth API.
+  # _This gem is not responsible for the numbers used._
+
   def self.get_element_by_id(element_name, id)
     begin
       response = RestClient.get Api_Links[element_name] + id.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appolo
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Pedro Gabriel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 description: |-
   Ruby gem that provides quick and easy access to the web api of Thoth WebApp -
                           https://adeetc.thothapp.com/
@@ -107,9 +121,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/example.rb
-- bin/setup
 - lib/Appolo.rb
 - lib/Appolo/Models/element.rb
 - lib/Appolo/Models/main_model/classes.rb
@@ -146,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Provides easy access to Thoth web API

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

@@ -1,30 +0,0 @@
-#!/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

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