appolo 1.2.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a8dce19c2f19fd5335d2a1118e9c06a5f706132
-  data.tar.gz: e37dc28eaa44895a5104527f717fea6e32b128c8
+  metadata.gz: ecc284a43e5df985d8dc112580091bbf85f59bb7
+  data.tar.gz: 78fbd70effa5701950d40863f8e732349012700a
 SHA512:
-  metadata.gz: 170b6d32b06d178eaceb1e64aa8da24a4836c6ffce1862e59be3b6137a47ec8bc9ede5a1a47362701814c90be1abdf3f947102e6cf647b1dd5c3ad8933c6a467
-  data.tar.gz: cfb7f57bc1d21431c20e7df831726933c5cc78e3a8ac2a4a6364064c5c9516684d8c67db8a79ff2a3d42abf829413391024b2ebb19038bdcc33f64bb5f59e091
+  metadata.gz: f4ba4b2b85bf5fa7765bf71e8848cca7e15e468c07efbb718a3fc0110c6c2e0811ef6e14fefa98e68069473d547bfe65d85c1cbc9859994f0c0cafe734afd3c5
+  data.tar.gz: c1965a86e1dd129fbc52b7e9dd5f6deca8b41fdd2bd028d8ddf5f0e4351f28d09f98d4f2081e03232ec679804c6fefa42a2aca37b9215dc644e7b0076a7878f2

data/README.md

@@ -11,7 +11,9 @@ This project does not intends to show any super efficient or professional progra
 Add this line to your application's Gemfile:
 
 ```ruby
+
 gem 'Appolo'
+
 ```
 
 And then execute:
@@ -24,23 +26,41 @@ Or install it yourself as:
 
 ## Usage
 
+In order to specify which element to get, you can use one of the following
+symbols:
+
+* :classes
+* :students
+* :programs
+* :courses
+* :lec_semesters
+* :teachers
+
+Take a look at the tests for more info.
+
+
 The following line of code
 
 ```ruby
-puts Appolo::get_student_by_id 38209
+
+puts Appolo::get_element_by_id(:students,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
+
+some_class = Appolo.get_element_by_id(:classes, 409)
 all_lectures_now = some_class.lectures
 
 puts all_lectures[0].title
@@ -49,24 +69,30 @@ 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
+
+some_class = .get_element_by_id(:classes, 409)
 participants = some_class.participants
 
 puts participants[0].name
-# Humberto Pedro Pinto da Silva
+#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
+student = .get_element_by_id(:students, id)
 puts student.short_name
 # Humberto Silva
+
 ```
 
 ## Development

data/lib/Appolo/version.rb

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

data/lib/Appolo.rb

@@ -11,19 +11,12 @@ require 'json'
 
 ##
 # This module is the main provider for the public API that
-# this gem contains.
+# this gem provides.
 
 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
@@ -31,16 +24,45 @@ module Appolo
   $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'
+  ##
+  # This hash contains each hash structure that contains the different
+  # elements after being requested by the method Appolo#get_set_of_elements
+  Elements = {
+      :students => $all_students,
+      :teachers => $all_teachers,
+      :classes => $all_classes,
+      :programs => $all_programs,
+      :courses => $all_courses,
+      :lec_semesters => $all_lective_sem
+  }
+
+  ##
+  # This hash structure contains the main web links in order to perform
+  # and build future http requests. This set of links are based upon the
+  # Thoth WebApp REST API.
+  # ---
+  # Check https://adeetc.thothapp.com/api/doc for more info.
+  Api_Links = {
+      :students => 'https://adeetc.thothapp.com/api/v1/students/',
+      :teachers => 'https://adeetc.thothapp.com/api/v1/teachers/',
+      :classes  => 'https://adeetc.thothapp.com/api/v1/classes/',
+      :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'
+
+  }
+
+  Api_Codename = {
+      :students => 'students',
+      :teachers => 'teachers',
+      :classes  => 'classes',
+      :programs => 'programs',
+      :courses  => 'courseUnits',
+      :lec_semesters => 'lectiveSemesters'
+  }
 
-  #TODO should raise exception when not 200
   def self.verify_response(resp)
+    #I dont like this nil..
     (resp.code == 200) ? resp : nil
   end
 
@@ -56,176 +78,48 @@ module Appolo
     Result.new(result, error)
   end
 
+  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}}
+  }
+
+  Builder_Element = {
+      students: lambda{|data| Student.new(verify_response data)},
+      teachers: lambda{|data| Teacher.new(verify_response data)},
+      classes: lambda{|data| Classes.new(verify_response data)},
+      programs: lambda{|data| Program.new(verify_response data)},
+      courses: lambda{|data| CourseUnit.new(verify_response data)},
+      lec_semesters: lambda{|data| LectiveSemester.new(verify_response data)}
+  }
 
   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
-      $all_students
-    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
-      $all_teachers
-    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
-      $all_programs
-    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
-      $all_courses
-    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
+  def self.get_set_of_elements(element_name)
+    return Elements[element_name] unless Elements[element_name].length == 0
     begin
-      response = RestClient.get LECTIVE_SEMESTERS_API_LINK
+      response = RestClient.get Api_Links[element_name]
       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.id] = stub
-      end
-      $all_lective_sem
+      element_api_codename = Api_Codename[element_name]
+      set_of_elements = JSON.parse(valid_resp)
+      set_of_elements = set_of_elements[element_api_codename]
+      Builder_Elements[element_name].call(set_of_elements)
+      Elements[element_name]
     rescue => e
-      $all_lective_sem
+      Elements[element_name]
     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
-      $all_classes
-    end
-  end
-
-  ##
-  # Return a single instance of Teacher based upon the +id+ given.
-
-  def self.get_teacher_by_id(id)
-    #return $all_teachers[id] unless $all_teachers.count == 0
-    begin
-      response = RestClient.get TEACHERS_API_LINK + id.to_s
-      Teacher.new(verify_response response)
-    rescue => e
-      e
-    end
-  end
-
-  
-  ##
-  # Return a single instance of Classes based upon the +id+ given.
-
-  def self.get_class_by_id(id)
-    #return $all_classes[id] unless $all_classes.count == 0
-    begin
-      response = RestClient.get CLASSES_API_LINK + id.to_s
-      Classes.new(verify_response response)
-    rescue => e
-     e
-    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
-      e
-    end
-  end
-
-  ##
-  # Return a single instance of program based upon the +id+ given.
-
-  def self.get_program_by_id(id)
-    #return $all_programs[id] unless $all_programs.count == 0
+  def self.get_element_by_id(element_name, id)
     begin
-      response = RestClient.get PROGRAMS_API_LINK + id.to_s
-      Program.new(verify_response response)
+      response = RestClient.get Api_Links[element_name] + id.to_s
+      Builder_Element[element_name].call(response)
     rescue => e
       e
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appolo
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Pedro Gabriel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-03 00:00:00.000000000 Z
+date: 2015-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,7 +102,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".travis.yml"
 - Appolo.gemspec
 - Gemfile
 - LICENSE.txt

data/.travis.yml

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