learnsprout 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,7 @@
-learnsprout
-===========
-
-A Ruby wrapper for the LearnSprout API
+# LearnSprout Ruby Gem
+
+A Ruby wrapper for the [LearnSprout API](http://developers.learnsprout.com/interactive)
+
+## Getting Started
+
+    $ gem install learnsprout

data/features/sections.feature

@@ -42,3 +42,38 @@ Feature: Get Sections
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request a section with id 4fdb1f6691e4e649b7000000 for that org
         * I should get a section with id 4fdb1f6691e4e649b7000000
+
+    Scenario: Term for section
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a section with id 4fdb1f6691e4e649b7000000 for that org
+        * When I request the term for that section
+        * I should get a term with id 4fdb21cb91e4e64a0600000b
+
+    Scenario: Teacher for section
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a section with id 4fdb1f6691e4e649b7000000 for that org
+        * When I request the teacher for that section
+        * I should get a teacher with id 4fdb1ffaaa411b22c9a49e10
+
+    Scenario: School for section
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a section with id 4fdb1f6691e4e649b7000000 for that org
+        * When I request the school for that section
+        * I should get a school with id 4fdac86faa411b22c9a3fd2f
+
+    Scenario: Course for section
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a section with id 4fdb1f6691e4e649b7000000 for that org
+        * When I request the course for that section
+        * I should get a course with id 4fdac84faa411b22c9a3fd1b
+
+    Scenario: Students for section
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a section with id 4fdb1f6691e4e649b7000000 for that org
+        * When I request the students for that section
+        * I should get a list of 21 students

data/features/step_definitions/client_steps.rb

@@ -135,6 +135,26 @@ Given /^(?:When )?I request a section with id ([a-f0-9]{24}) for that org$/ do |
     @section = @org.section(section_id)
 end
 
+Given /^(?:When )?I request the term for that section$/ do
+    @term = @section.term
+end
+
+Given /^(?:When )?I request the students for that section$/ do
+    @students = @section.students
+end
+
+Given /^(?:When )?I request the teacher for that section$/ do
+    @teacher = @section.teacher
+end
+
+Given /^(?:When )?I request the school for that section$/ do
+    @school = @section.school
+end
+
+Given /^(?:When )?I request the course for that section$/ do
+    @course = @section.course
+end
+
 # Teachers
 
 Given /^When I request teachers for an organization with id ([a-f0-9]{24})$/ do |org_id|
@@ -173,6 +193,10 @@ Given /^(?:When )?I request a teacher with id ([a-f0-9]{24}) for that org$/ do |
     @teacher = @org.teacher(teacher_id)
 end
 
+Given /^(?:When )?I request the school for that teacher$/ do
+    @school = @teacher.school
+end
+
 # Terms
 
 Given /^When I request terms for an organization with id ([a-f0-9]{24})$/ do |org_id|
@@ -224,6 +248,10 @@ Given /^(?:When )?I request the current term for an org with id ([a-f0-9]{24}) a
     @term = @client.current_term(org_id, school_id)
 end
 
+Given /^(?:When )?I request the sections for that term$/ do
+    @sections = @term.sections
+end
+
 # Courses
 
 Given /^When I request courses for an organization with id ([a-f0-9]{24})$/ do |org_id|

data/features/teachers.feature

@@ -42,3 +42,10 @@ Feature: Get Teachers
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request a teacher with id 4fdb1fceaa411b22c9a49d54 for that org
         * I should get a teacher with id 4fdb1fceaa411b22c9a49d54
+
+    Scenario: School for teacher
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a teacher with id 4fdb1fceaa411b22c9a49d54 for that org
+        * When I request the school for that teacher
+        * I should get a school with id 4fdac86faa411b22c9a3fd2f

data/features/term.feature

@@ -54,3 +54,10 @@ Feature: Get Terms
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request the current term for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
         * I should get the current term
+
+    Scenario: Sections for term
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request an org with id 4fdaeaa92eea44952ab9e520
+        * I request a term with id 4fdb21cb91e4e64a06000008 for that org
+        * When I request the sections for that term
+        * I should get a list of 80 sections

data/lib/learnsprout/course.rb

@@ -1,6 +1,5 @@
 module LearnSprout
   class Course
-    include LearnSprout::Connection
 
     attr_accessor :course_id,
                   :school_id,

data/lib/learnsprout/org.rb

@@ -1,6 +1,5 @@
 module LearnSprout
   class Org
-    include LearnSprout::Connection
 
     attr_accessor :org_id,
                   :name

data/lib/learnsprout/phone.rb

@@ -1,12 +1,14 @@
-module LearnSprout
-  class Phone
-
-    attr_accessor :fax,
-                  :main
-
-    def initialize(attrs={})
-        @fax = attrs["fax"]
-        @main = attrs["main"]
-    end
-  end
-end 
+module LearnSprout
+  class Phone
+
+    attr_accessor :fax,
+                  :main,
+                  :home
+
+    def initialize(attrs={})
+        @fax = attrs["fax"]
+        @main = attrs["main"]
+        @home = attrs["home"]
+    end
+  end
+end 

data/lib/learnsprout/school.rb

@@ -1,69 +1,70 @@
-module LearnSprout
-  class School
-    include LearnSprout::Connection
-
-    attr_accessor :school_id,
-                  :name,
-                  :number,
-                  :nces,
-                  :phone,
-                  :address
-
-    def initialize(attrs={})
-        @client = attrs["client"]
-        @org_id = attrs["org_id"]
-        @school_id = attrs["id"]
-        @name = attrs["name"]
-        @number = attrs["number"]
-        @nces = Nces.new(attrs["nces"])
-        @phone = Phone.new(attrs["phone"])
-        @address = Address.new(attrs["address"])
-    end
-
-    #TODO Add org method?
-
-    def student(student_id)
-        @client.student(@org_id, student_id)
-    end
-
-    def students
-      @client.students(@org_id, :school_id => @school_id)
-    end
-
-    def section(section_id)
-        @client.section(@org_id, section_id)
-    end
-
-    def sections
-      @client.sections(@org_id, :school_id => @school_id)
-    end
-
-    def teacher(teacher_id)
-        @client.teacher(@org_id, teacher_id)
-    end
-
-    def teachers
-      @client.teachers(@org_id, :school_id => @school_id)
-    end
-
-    def term(term_id)
-        @client.term(@org_id, term_id)
-    end
-
-    def terms
-      @client.terms(@org_id, :school_id => @school_id)
-    end
-
-    def current_term
-      @client.current_term(@org_id, @school_id)
-    end
-
-    def course(course_id)
-        @client.course(@org_id, course_id)
-    end
-
-    def courses
-      @client.courses(@org_id, :school_id => @school_id)
-    end
-  end
-end 
+module LearnSprout
+  class School
+
+    attr_accessor :school_id,
+                  :name,
+                  :number,
+                  :nces,
+                  :phone,
+                  :address,
+                  :time_updated
+
+    def initialize(attrs={})
+        @client = attrs["client"]
+        @org_id = attrs["org_id"]
+        @school_id = attrs["id"]
+        @name = attrs["name"]
+        @number = attrs["number"]
+        @nces = Nces.new(attrs["nces"])
+        @phone = Phone.new(attrs["phone"])
+        @address = Address.new(attrs["address"])
+        @time_updated = attrs["time_updated"]
+    end
+
+    #TODO Add org method?
+
+    def student(student_id)
+        @client.student(@org_id, student_id)
+    end
+
+    def students
+      @client.students(@org_id, :school_id => @school_id)
+    end
+
+    def section(section_id)
+        @client.section(@org_id, section_id)
+    end
+
+    def sections
+      @client.sections(@org_id, :school_id => @school_id)
+    end
+
+    def teacher(teacher_id)
+        @client.teacher(@org_id, teacher_id)
+    end
+
+    def teachers
+      @client.teachers(@org_id, :school_id => @school_id)
+    end
+
+    def term(term_id)
+        @client.term(@org_id, term_id)
+    end
+
+    def terms
+      @client.terms(@org_id, :school_id => @school_id)
+    end
+
+    def current_term
+      @client.current_term(@org_id, @school_id)
+    end
+
+    def course(course_id)
+        @client.course(@org_id, course_id)
+    end
+
+    def courses
+      @client.courses(@org_id, :school_id => @school_id)
+    end
+  end
+end 

data/lib/learnsprout/section.rb

@@ -1,10 +1,14 @@
 module LearnSprout
   class Section
-    include LearnSprout::Connection
 
-    attr_accessor :section_id,
+    attr_accessor :term_id,
+                  :section_id,
                   :number,
-                  :room
+                  :room,
+                  :time_updated,
+                  :teacher_id,
+                  :school_id,
+                  :course_id
 
     def initialize(attrs={})
         @client = attrs["client"]
@@ -12,7 +16,43 @@ module LearnSprout
         @section_id = attrs["id"]
         @number = attrs["number"]
         @room = attrs["room"]
-        #TODO: Other attrs
+        @term_id = attrs["term"] && attrs["term"]["id"]
+        @teacher_id = attrs["teacher"] && attrs["teacher"]["id"]
+        @school_id = attrs["school"] && attrs["school"]["id"]
+        @course_id = attrs["course"] && attrs["course"]["id"]
+        @time_updated = attrs["time_updated"]
+        @student_ids = []
+        if attrs["students"]
+            attrs["students"].each do |student|
+                @student_ids.push student["id"]
+            end
+        end
+    end
+
+    def term
+        @term_id && @client.term(@org_id, @term_id)
+    end
+
+    def teacher
+        @teacher_id && @client.teacher(@org_id, @teacher_id)
+    end
+
+    def school
+        @school_id && @client.school(@org_id, @school_id)
+    end
+
+    def course
+        @course_id && @client.course(@org_id, @course_id)
+    end
+
+    def students
+      temp_students = []
+      if @student_ids.count > 0
+         @student_ids.each do |student_id|
+           temp_students.push @client.student(@org_id, student_id)
+         end
+      end
+      return temp_students
     end
   end
 end 

data/lib/learnsprout/student.rb

@@ -1,16 +1,38 @@
 module LearnSprout
   class Student
-    include LearnSprout::Connection
 
     attr_accessor :student_id,
-                  :name
+                  :last_name,
+                  :grade,
+                  :address,
+                  :school_id,
+                  :number,
+                  :phone,
+                  :birthday,
+                  :first_name,
+                  :time_updated,
+                  :middle_name,
+                  :gender,
+                  :exit_date,
+                  :entry_date
 
     def initialize(attrs={})
         @client = attrs["client"]
         @org_id = attrs["org_id"]
         @student_id = attrs["id"]
-        @name = attrs["name"]
-        #TODO: Other attrs
+        @last_name = attrs["last_name"]
+        @grade = attrs["grade"]
+        @address = Address.new(attrs["address"])
+        @school_id = attrs["school"]["id"]
+        @number = attrs["number"]
+        @phone = Phone.new(attrs["phone"])
+        @birthday = attrs["birthday"] && Date.parse(attrs["birthday"])
+        @first_name = attrs["first_name"]
+        @time_updated = attrs["time_updated"]
+        @middle_name = attrs["middle_name"]
+        @gender = attrs["gender"]
+        @exit_date = attrs["exit_date"] && Date.parse(attrs["exit_date"])
+        @entry_date = attrs["entry_date"] && Date.parse(attrs["entry_date"])
     end
   end
 end 

data/lib/learnsprout/teacher.rb

@@ -1,18 +1,18 @@
 module LearnSprout
   class Teacher
-    include LearnSprout::Connection
 
     attr_accessor :teacher_id,
                   :first_name,
                   :middle_name,
                   :last_name,
                   :title,
+                  :address,
+                  :school_id,
                   :number,
+                  :phone,
                   :time_updated,
                   :email
 
-    #TODO Other fields
-
     def initialize(attrs={})
         @client = attrs["client"]
         @org_id = attrs["org_id"]
@@ -21,10 +21,16 @@ module LearnSprout
         @middle_name = attrs["middle_name"]
         @last_name = attrs["last_name"]
         @title = attrs["title"]
+        @address = attrs["address"] && Address.new(attrs["address"])
+        @school_id = attrs["school"] && attrs["school"]["id"]
         @number = attrs["number"]
+        @phone = attrs["phone"] && Phone.new(attrs["phone"])
         @time_updated = attrs["time_updated"]
         @email = attrs["email"]
-        #TODO: Other attrs
+    end
+
+    def school
+        @school_id && @client.school(@org_id, @school_id)
     end
   end
 end 

data/lib/learnsprout/term.rb

@@ -1,22 +1,38 @@
 module LearnSprout
   class Term
-    include LearnSprout::Connection
 
     attr_accessor :term_id,
                   :name,
                   :end_date,
-                  :start_date
-
-    #TODO Other fields
+                  :start_date,
+                  :school_id,
+                  :time_updated
 
     def initialize(attrs={})
         @client = attrs["client"]
         @org_id = attrs["org_id"]
         @term_id = attrs["id"]
         @name = attrs["name"]
-        @end_date = Date.parse(attrs["end_date"])
-        @start_date = Date.parse(attrs["start_date"])
-        #TODO: Other attrs
+        @end_date = attrs["end_date"] && Date.parse(attrs["end_date"])
+        @start_date = attrs["start_date"] && Date.parse(attrs["start_date"])
+        @school_id = attrs["school_id"]
+        @time_updated = attrs["time_updated"]
+        @section_ids = []
+        if attrs["sections"]
+            attrs["sections"].each do |section|
+                @section_ids.push section["id"]
+            end
+        end
+    end
+
+    def sections
+      temp_sections = []
+      if @section_ids.count > 0
+         @section_ids.each do |section_id|
+           temp_sections.push @client.section(@org_id, section_id)
+         end
+      end
+      return temp_sections
     end
   end
 end 

data/lib/learnsprout/version.rb

@@ -1,4 +1,4 @@
 module LearnSprout
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Francis Kam