learnsprout 0.0.2 → 0.0.3

data/features/courses.feature

@@ -5,25 +5,25 @@ Feature: Get Courses
     Scenario: List courses by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request courses for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 23 courses
+        * I should get a page of 23 items
 
     Scenario: List courses by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request courses for that org
-        * I should get a list of 23 courses
+        * I should get a page of 23 items
 
     Scenario: List courses by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request courses for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86faa411b22c9a3fd2f
-        * I should get a list of 18 courses
+        * I should get a page of 18 items
 
     Scenario: List courses by school
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * I request a school with id 4fdac86faa411b22c9a3fd2f for that org
         * When I request courses for that school
-        * I should get a list of 18 courses
+        * I should get a page of 18 items
 
     Scenario: Course by school and course id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/orgs.feature

@@ -5,7 +5,7 @@ Feature: Get Orgs
     Scenario: List all orgs
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request orgs
-        * I should get the organization with id 4fdaeaa92eea44952ab9e520
+        * I should get a list of 2 orgs
 
     Scenario: Org by ID
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/schools.feature

@@ -5,13 +5,13 @@ Feature: Get Schools
     Scenario: List schools by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request schools for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 7 schools
+        * I should get a page of 7 items
 
     Scenario: List schools by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request schools for that org
-        * I should get a list of 7 schools
+        * I should get a page of 7 items
 
     Scenario: School by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/sections.feature

@@ -5,25 +5,31 @@ Feature: Get Sections
     Scenario: List sections by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request sections for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 50 sections
+        * I should get a page of 50 items
 
     Scenario: List sections by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request sections for that org
-        * I should get a list of 50 sections
+        * I should get a page of 50 items
 
     Scenario: List sections by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request sections for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
-        * I should get a list of 50 sections
+        * I should get a page of 50 items
 
     Scenario: List sections by school
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * I request a school with id 4fdac86eaa411b22c9a3fd2e for that org
         * When I request sections for that school
-        * I should get a list of 50 sections
+        * I should get a page of 50 items
+
+    Scenario: List next page of sections
+        * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
+        * I request sections for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
+        * When I request the next page
+        * I should get a page of 30 items
 
     Scenario: Section by school and section id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/step_definitions/client_steps.rb

@@ -10,6 +10,16 @@ end
 After do
 end
 
+# Miscellaneous
+
+Given /^I should get a page of (\d+) items$/ do |count|
+    @page.items.count.should == Integer(count)
+end
+
+Given /^(?:When )?I request the next page$/ do
+    @page = @page.next
+end
+
 # Client
 
 Given /^I have entered my api key as ([a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})$/ do |api_key|
@@ -20,6 +30,10 @@ Given /^(?:When )?I request orgs$/ do
     @orgs = @client.orgs
 end
 
+Given /^I should get a list of (\d+) orgs$/ do |count|
+    @orgs.count.should == Integer(count)
+end
+
 Given /^I should get the organization with id ([a-f0-9]{24})$/ do |org_id|
     org = @orgs.first
     org.org_id.should == org_id
@@ -36,11 +50,7 @@ end
 # Schools
 
 Given /^(?:When )?I request schools for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @schools = @client.schools(org_id)
-end
-
-Given /^I should get a list of (\d+) schools$/ do |count|
-    @schools.count.should == Integer(count)
+    @page = @client.schools(org_id)
 end
 
 Given /^(?:When )?I request a school with id ([a-f0-9]{24}) for that org$/ do |school_id|
@@ -52,7 +62,7 @@ Given /^I should get a school with id ([a-f0-9]{24})$/ do |school_id|
 end
 
 Given /^(?:When )?I request schools for that org$/ do
-    @schools = @org.schools
+    @page = @org.schools
 end
 
 Given /^(?:When )?I request a school with id ([a-f0-9]{24}) for an org with id ([a-f0-9]{24})$/ do |school_id, org_id|
@@ -62,7 +72,7 @@ end
 # Students
 
 Given /^(?:When )?I request students for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @students = @client.students(org_id)
+    @page = @client.students(org_id)
 end
 
 Given /^I should get a list of (\d+) students$/ do |count|
@@ -70,7 +80,7 @@ Given /^I should get a list of (\d+) students$/ do |count|
 end
 
 Given /^(?:When )?I request students for that org$/ do
-    @students = @org.students
+    @page = @org.students
 end
 
 Given /^I should get a student with id ([a-f0-9]{24})$/ do |student_id|
@@ -90,17 +100,17 @@ Given /^(?:When )?I request a student with id ([a-f0-9]{24}) for that org$/ do |
 end
 
 Given /^(?:When )?I request students for an org with id ([a-f0-9]{24}) and a school with id ([a-f0-9]{24})$/ do |org_id, school_id|
-    @students = @client.students(org_id, school_id)
+    @page = @client.students(org_id, school_id)
 end
 
 Given /^(?:When )?I request students for that school$/ do
-    @students = @school.students
+    @page = @school.students
 end
 
 # Sections
 
 Given /^When I request sections for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @sections = @client.sections(org_id)
+    @page = @client.sections(org_id)
 end
 
 Given /^I should get a list of (\d+) sections$/ do |count|
@@ -108,15 +118,15 @@ Given /^I should get a list of (\d+) sections$/ do |count|
 end
 
 Given /^(?:When )?I request sections for that org$/ do
-    @sections = @org.sections
+    @page = @org.sections
 end
 
 Given /^(?:When )?I request sections for an org with id ([a-f0-9]{24}) and a school with id ([a-f0-9]{24})$/ do |org_id, school_id|
-    @sections = @client.sections(org_id, :school_id => school_id)
+    @page = @client.sections(org_id, :school_id => school_id)
 end
 
 Given /^(?:When )?I request sections for that school$/ do
-    @sections = @school.sections
+    @page = @school.sections
 end
 
 Given /^(?:When )?I request a section with id ([a-f0-9]{24}) for that school$/ do |section_id|
@@ -158,23 +168,19 @@ end
 # Teachers
 
 Given /^When I request teachers for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @teachers = @client.teachers(org_id)
-end
-
-Given /^I should get a list of (\d+) teachers$/ do |count|
-    @teachers.count.should == Integer(count)
+    @page = @client.teachers(org_id)
 end
 
 Given /^(?:When )?I request teachers for that org$/ do
-    @teachers = @org.teachers
+    @page = @org.teachers
 end
 
 Given /^(?:When )?I request teachers for an org with id ([a-f0-9]{24}) and a school with id ([a-f0-9]{24})$/ do |org_id, school_id|
-    @teachers = @client.teachers(org_id, :school_id => school_id)
+    @page = @client.teachers(org_id, :school_id => school_id)
 end
 
 Given /^(?:When )?I request teachers for that school$/ do
-    @teachers = @school.teachers
+    @page = @school.teachers
 end
 
 Given /^(?:When )?I request a teacher with id ([a-f0-9]{24}) for that school$/ do |teacher_id|
@@ -200,23 +206,19 @@ end
 # Terms
 
 Given /^When I request terms for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @terms = @client.terms(org_id)
-end
-
-Given /^I should get a list of (\d+) terms$/ do |count|
-    @terms.count.should == Integer(count)
+    @page = @client.terms(org_id)
 end
 
 Given /^(?:When )?I request terms for that org$/ do
-    @terms = @org.terms
+    @page = @org.terms
 end
 
 Given /^(?:When )?I request terms for an org with id ([a-f0-9]{24}) and a school with id ([a-f0-9]{24})$/ do |org_id, school_id|
-    @terms = @client.terms(org_id, :school_id => school_id)
+    @page = @client.terms(org_id, :school_id => school_id)
 end
 
 Given /^(?:When )?I request terms for that school$/ do
-    @terms = @school.terms
+    @page = @school.terms
 end
 
 Given /^(?:When )?I request a term with id ([a-f0-9]{24}) for that school$/ do |term_id|
@@ -255,23 +257,19 @@ end
 # Courses
 
 Given /^When I request courses for an organization with id ([a-f0-9]{24})$/ do |org_id|
-    @courses = @client.courses(org_id)
-end
-
-Given /^I should get a list of (\d+) courses$/ do |count|
-    @courses.count.should == Integer(count)
+    @page = @client.courses(org_id)
 end
 
 Given /^(?:When )?I request courses for that org$/ do
-    @courses = @org.courses
+    @page = @org.courses
 end
 
 Given /^(?:When )?I request courses for an org with id ([a-f0-9]{24}) and a school with id ([a-f0-9]{24})$/ do |org_id, school_id|
-    @courses = @client.courses(org_id, :school_id => school_id)
+    @page = @client.courses(org_id, :school_id => school_id)
 end
 
 Given /^(?:When )?I request courses for that school$/ do
-    @courses = @school.courses
+    @page = @school.courses
 end
 
 Given /^(?:When )?I request a course with id ([a-f0-9]{24}) for that school$/ do |course_id|

data/features/students.feature

@@ -5,25 +5,25 @@ Feature: Get Students
     Scenario: List students by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request students for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 50 students
+        * I should get a page of 50 items
 
     Scenario: List students by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request students for that org
-        * I should get a list of 50 students
+        * I should get a page of 50 items
 
     Scenario: List students by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request students for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
-        * I should get a list of 50 students
+        * I should get a page of 50 items
 
     Scenario: List students by school
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * I request a school with id 4fdac86eaa411b22c9a3fd2e for that org
         * When I request students for that school
-        * I should get a list of 50 students
+        * I should get a page of 50 items
 
     Scenario: Student by org id and student id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/teachers.feature

@@ -5,25 +5,25 @@ Feature: Get Teachers
     Scenario: List teachers by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request teachers for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 50 teachers
+        * I should get a page of 50 items
 
     Scenario: List teachers by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request teachers for that org
-        * I should get a list of 50 teachers
+        * I should get a page of 50 items
 
     Scenario: List teachers by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request teachers for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
-        * I should get a list of 28 teachers
+        * I should get a page of 28 items
 
     Scenario: List teachers by school
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * I request a school with id 4fdac86eaa411b22c9a3fd2e for that org
         * When I request teachers for that school
-        * I should get a list of 28 teachers
+        * I should get a page of 28 items
 
     Scenario: Teacher by school and teacher id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/features/term.feature

@@ -5,25 +5,25 @@ Feature: Get Terms
     Scenario: List terms by org id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request terms for an organization with id 4fdaeaa92eea44952ab9e520
-        * I should get a list of 20 terms
+        * I should get a page of 20 items
 
     Scenario: List terms by org
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * When I request terms for that org
-        * I should get a list of 20 terms
+        * I should get a page of 20 items
 
     Scenario: List terms by org id and school id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * When I request terms for an org with id 4fdaeaa92eea44952ab9e520 and a school with id 4fdac86eaa411b22c9a3fd2e
-        * I should get a list of 1 terms
+        * I should get a page of 1 items
 
     Scenario: List terms by school
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18
         * I request an org with id 4fdaeaa92eea44952ab9e520
         * I request a school with id 4fdac86eaa411b22c9a3fd2e for that org
         * When I request terms for that school
-        * I should get a list of 1 terms
+        * I should get a page of 1 items
 
     Scenario: Term by school and term id
         * I have entered my api key as fcb8534c-e4ee-4e02-8b22-9328db1dac18

data/lib/learnsprout.rb

@@ -45,4 +45,5 @@ require "learnsprout/course"
 require "learnsprout/nces"
 require "learnsprout/phone"
 require "learnsprout/address"
+require "learnsprout/page"
 require "learnsprout/version"

data/lib/learnsprout/client.rb

@@ -26,7 +26,7 @@ module LearnSprout
 
     def schools(org_id)
       schools = get("org/#{org_id}/school?apikey=#{@api_key}")
-      instances_from_schools(org_id, schools)
+      Page.new("org/#{org_id}/school?apikey=#{@api_key}", School, :client => self, :org_id => org_id)
     end
 
     def student(org_id, student_id)
@@ -39,11 +39,11 @@ module LearnSprout
     def students(org_id, options = {})
       school_id = options[:school_id]
       if (school_id)
-        students = get("org/#{org_id}/school/#{school_id}/student?apikey=#{@api_key}")
+        url = "org/#{org_id}/school/#{school_id}/student?apikey=#{@api_key}"
       else
-        students = get("org/#{org_id}/student?apikey=#{@api_key}")
+        url = "org/#{org_id}/student?apikey=#{@api_key}"
       end
-      instances_from_students(org_id, students)
+      Page.new(url, Student, :org_id => org_id, :client => self)
     end
 
     def section(org_id, section_id)
@@ -61,8 +61,7 @@ module LearnSprout
       else
         url = "org/#{org_id}/section?apikey=#{@api_key}"
       end
-      sections = get(url)
-      instances_from_sections(org_id, sections)
+      Page.new(url, Section, :org_id => org_id, :client => self)
     end
 
     def teacher(org_id, teacher_id)
@@ -80,8 +79,7 @@ module LearnSprout
       else
         url = "org/#{org_id}/teacher?apikey=#{@api_key}"
       end
-      teachers = get(url)
-      instances_from_teachers(org_id, teachers)
+      Page.new(url, Teacher, :org_id => org_id, :client => self)
     end
 
     def term(org_id, term_id)
@@ -99,8 +97,7 @@ module LearnSprout
       else
         url = "org/#{org_id}/term?apikey=#{@api_key}"
       end
-      terms = get(url)
-      instances_from_terms(org_id, terms)
+      Page.new(url, Term, :org_id => org_id, :client => self)
     end
 
     def current_term(org_id, school_id)
@@ -126,8 +123,7 @@ module LearnSprout
       else
         url = "org/#{org_id}/course?apikey=#{@api_key}"
       end
-      courses = get(url)
-      instances_from_courses(org_id, courses)
+      Page.new(url, Course, :org_id => org_id, :client => self)
     end
 
     private
@@ -139,71 +135,5 @@ module LearnSprout
         end
         return org_instances
       end
-
-      def instances_from_schools(org_id, schools)
-        school_instances = []
-        #TODO Next
-        schools["data"].each do |school|
-          school["client"] = self
-          school["org_id"] = org_id
-          school_instances << School.new(school)
-        end
-        return school_instances
-      end
-
-      def instances_from_students(org_id, students)
-        student_instances = []
-        #TODO Next
-        students["data"].each do |student|
-          student["client"] = self
-          student["org_id"] = org_id
-          student_instances << Student.new(student)
-        end
-        return student_instances
-      end
-
-      def instances_from_sections(org_id, sections)
-        section_instances = []
-        #TODO Next
-        sections["data"].each do |section|
-          section["client"] = self
-          section["org_id"] = org_id
-          section_instances << Section.new(section)
-        end
-        return section_instances
-      end
-
-      def instances_from_teachers(org_id, teachers)
-        teacher_instances = []
-        #TODO Next
-        teachers["data"].each do |teacher|
-          teacher["client"] = self
-          teacher["org_id"] = org_id
-          teacher_instances << Teacher.new(teacher)
-        end
-        return teacher_instances
-      end
-
-      def instances_from_terms(org_id, terms)
-        term_instances = []
-        #TODO Next
-        terms["data"].each do |term|
-          term["client"] = self
-          term["org_id"] = org_id
-          term_instances << Term.new(term)
-        end
-        return term_instances
-      end
-
-      def instances_from_courses(org_id, courses)
-        course_instances = []
-        #TODO Next
-        courses["data"].each do |course|
-          course["client"] = self
-          course["org_id"] = org_id
-          course_instances << Course.new(course)
-        end
-        return course_instances
-      end
   end
 end

data/lib/learnsprout/page.rb

@@ -0,0 +1,33 @@
+module LearnSprout
+    class Page
+        include LearnSprout::Connection
+
+        attr_accessor :items
+
+        def initialize(url, type, extras = {})
+            @items = []
+            @type = type
+            @extras = extras
+            data = get(url)
+
+            @nextUrl = data["next"].to_s
+            # Remove base URL if it's included
+            prefix = LearnSprout.endpoint.to_s
+            if @nextUrl[0, prefix.length] == prefix
+                @nextUrl = @nextUrl[prefix.length, @nextUrl.length - prefix.length]
+            end
+
+            #TODO handle non-page URL?
+            data["data"].each do |item|
+                extras.each do |key, value|
+                    item[key] = value
+                end
+                @items << type.new(item)
+            end
+        end
+
+        def next
+            return Page.new(@nextUrl, @type, @extras)
+        end
+    end
+end

data/lib/learnsprout/term.rb

@@ -25,6 +25,10 @@ module LearnSprout
         end
     end
 
+    # Gets the sections for this term. This method is extremely slow as it retrieves a list of IDs
+    # for associated terms then performs a separate request for each term for each ID.
+    #
+    # TODO Optimize somehow, perhaps by lazy loading
     def sections
       temp_sections = []
       if @section_ids.count > 0

data/lib/learnsprout/version.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Francis Kam
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-22 00:00:00 -07:00
+date: 2012-07-24 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -146,6 +146,7 @@ files:
 - lib/learnsprout/exceptions.rb
 - lib/learnsprout/nces.rb
 - lib/learnsprout/org.rb
+- lib/learnsprout/page.rb
 - lib/learnsprout/phone.rb
 - lib/learnsprout/response/follow_redirects.rb
 - lib/learnsprout/response/parse_json.rb