learnsprout 0.0.1

data/lib/learnsprout/client.rb

@@ -0,0 +1,209 @@
+module LearnSprout
+  class Client
+    include LearnSprout::Connection
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    def org(org_id)
+      org = get("org/#{org_id}?apikey=#{@api_key}")
+      org["client"] = self
+      Org.new(org)
+    end
+
+    def orgs
+      orgs = get("org?apikey=#{@api_key}")
+      instances_from_orgs(orgs)
+    end
+
+    def school(org_id, school_id)
+      school = get("org/#{org_id}/school/#{school_id}?apikey=#{@api_key}")
+      school["org_id"] = org_id
+      school["client"] = self
+      School.new(school)
+    end
+
+    def schools(org_id)
+      schools = get("org/#{org_id}/school?apikey=#{@api_key}")
+      instances_from_schools(org_id, schools)
+    end
+
+    def student(org_id, student_id)
+      student = get("org/#{org_id}/student/#{student_id}?apikey=#{@api_key}")
+      student["org_id"] = org_id
+      student["client"] = self
+      Student.new(student)
+    end
+
+    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}")
+      else
+        students = get("org/#{org_id}/student?apikey=#{@api_key}")
+      end
+      instances_from_students(org_id, students)
+    end
+
+    def section(org_id, section_id)
+      url = "org/#{org_id}/section/#{section_id}?apikey=#{@api_key}"
+      section = get(url)
+      section["org_id"] = org_id
+      section["client"] = self
+      Section.new(section)
+    end
+
+    def sections(org_id, options = {})
+      school_id = options[:school_id]
+      if (school_id)
+        url = "org/#{org_id}/school/#{school_id}/section?apikey=#{@api_key}"
+      else
+        url = "org/#{org_id}/section?apikey=#{@api_key}"
+      end
+      sections = get(url)
+      instances_from_sections(org_id, sections)
+    end
+
+    def teacher(org_id, teacher_id)
+      url = "org/#{org_id}/teacher/#{teacher_id}?apikey=#{@api_key}"
+      teacher = get(url)
+      teacher["org_id"] = org_id
+      teacher["client"] = self
+      Teacher.new(teacher)
+    end
+
+    def teachers(org_id, options = {})
+      school_id = options[:school_id]
+      if (school_id)
+        url = "org/#{org_id}/school/#{school_id}/teacher?apikey=#{@api_key}"
+      else
+        url = "org/#{org_id}/teacher?apikey=#{@api_key}"
+      end
+      teachers = get(url)
+      instances_from_teachers(org_id, teachers)
+    end
+
+    def term(org_id, term_id)
+      url = "org/#{org_id}/term/#{term_id}?apikey=#{@api_key}"
+      term = get(url)
+      term["org_id"] = org_id
+      term["client"] = self
+      Term.new(term)
+    end
+
+    def terms(org_id, options = {})
+      school_id = options[:school_id]
+      if (school_id)
+        url = "org/#{org_id}/school/#{school_id}/term?apikey=#{@api_key}"
+      else
+        url = "org/#{org_id}/term?apikey=#{@api_key}"
+      end
+      terms = get(url)
+      instances_from_terms(org_id, terms)
+    end
+
+    def current_term(org_id, school_id)
+      url = "org/#{org_id}/school/#{school_id}/term/current?apikey=#{@api_key}"
+      term = get(url)
+      term["org_id"] = org_id
+      term["client"] = self
+      Term.new(term)
+    end
+
+    def course(org_id, course_id)
+      url = "org/#{org_id}/course/#{course_id}?apikey=#{@api_key}"
+      course = get(url)
+      course["org_id"] = org_id
+      course["client"] = self
+      Course.new(course)
+    end
+
+    def courses(org_id, options = {})
+      school_id = options[:school_id]
+      if (school_id)
+        url = "org/#{org_id}/school/#{school_id}/course?apikey=#{@api_key}"
+      else
+        url = "org/#{org_id}/course?apikey=#{@api_key}"
+      end
+      courses = get(url)
+      instances_from_courses(org_id, courses)
+    end
+
+    private
+      def instances_from_orgs(orgs)
+        org_instances = []
+        orgs.each do |org|
+          org["client"] = self
+          org_instances << Org.new(org)
+        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/connection.rb

@@ -0,0 +1,45 @@
+module LearnSprout
+  module Connection
+    private
+      def connection
+        default_options = {
+          :headers => {
+            :accept => 'application/json',
+            :content_type => 'application/json',
+            :user_agent => LearnSprout.user_agent,
+          }
+        }
+
+        @connection ||= Faraday.new(LearnSprout.endpoint, default_options) do |builder|
+          builder.use LearnSprout::Response::FollowRedirects
+          builder.use LearnSprout::Response::ParseJson
+
+          builder.use Faraday::Request::UrlEncoded
+
+          builder.response :logger if LearnSprout.debugging?
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def get(path, params={})
+        request(:get, path, params)
+      end
+
+      def post(path, params={})
+        request(:post, path, params)
+      end
+
+      def request(method, path, params)
+        response = connection.send(method) do |request|
+          case method.to_sym
+          when :delete, :get
+            request.url(path)
+          when :post
+            request.path = path
+            request.body = MultiJson.encode(params) unless params.empty?
+          end
+        end
+        response.body
+      end
+  end
+end

data/lib/learnsprout/course.rb

@@ -0,0 +1,25 @@
+module LearnSprout
+  class Course
+    include LearnSprout::Connection
+
+    attr_accessor :course_id,
+                  :school_id,
+                  :name,
+                  :number,
+                  :time_updated
+
+    def initialize(attrs={})
+        @client = attrs["client"]
+        @org_id = attrs["org_id"]
+        @course_id = attrs["id"]
+        @name = attrs["name"]
+        @number = attrs["number"]
+        @time_updated = attrs["time_updated"]
+        @school_id = attrs["school"]["id"]
+    end
+
+    def school
+        @client.school(@org_id, @school_id)
+    end
+  end
+end 

data/lib/learnsprout/exceptions.rb

@@ -0,0 +1,5 @@
+module LearnSprout
+  class RequestException < Exception
+  end
+end
+

data/lib/learnsprout/nces.rb

@@ -0,0 +1,12 @@
+module LearnSprout
+  class Nces
+
+    attr_accessor :district_id,
+                  :school_id
+
+    def initialize(attrs={})
+        @district_id = attrs["district_id"]
+        @school_id = attrs["school_id"]
+    end
+  end
+end 

data/lib/learnsprout/org.rb

@@ -0,0 +1,62 @@
+module LearnSprout
+  class Org
+    include LearnSprout::Connection
+
+    attr_accessor :org_id,
+                  :name
+
+    def initialize(attrs={})
+      @client = attrs["client"]
+      @org_id = attrs["id"]
+      @name = attrs["name"]
+    end
+
+    def school(school_id)
+      @client.school(@org_id, school_id)
+    end
+
+    def schools
+      @client.schools(@org_id)
+    end
+
+    def students
+      @client.students(@org_id)
+    end
+
+    def student(student_id)
+      @client.student(@org_id, student_id)
+    end
+
+    def sections
+      @client.sections(@org_id)
+    end
+
+    def section(section_id)
+      @client.section(@org_id, section_id)
+    end
+
+    def teachers
+      @client.teachers(@org_id)
+    end
+
+    def teacher(teacher_id)
+      @client.teacher(@org_id, teacher_id)
+    end
+
+    def terms
+      @client.terms(@org_id)
+    end
+
+    def term(term_id)
+      @client.term(@org_id, term_id)
+    end
+
+    def courses
+      @client.courses(@org_id)
+    end
+
+    def course(course_id)
+      @client.course(@org_id, course_id)
+    end
+  end
+end 

data/lib/learnsprout/phone.rb

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

data/lib/learnsprout/response/follow_redirects.rb

@@ -0,0 +1,44 @@
+module LearnSprout
+  module Response
+    class RedirectLimitReached < Faraday::Error::ClientError
+      attr_reader :response
+    
+      def initialize(response)
+        super "too many redirects; last one to: #{response['location']}"
+        @response = response
+      end
+    end
+  
+    class FollowRedirects < Faraday::Middleware
+      REDIRECTS = [301, 302, 303, 307]
+      # default value for max redirects followed
+      FOLLOW_LIMIT = 3
+    
+      def initialize(app, options = {})
+        super(app)
+        @options = options
+        @follow_limit = options[:limit] || FOLLOW_LIMIT
+      end
+    
+      def call(env)
+        process_response(@app.call(env), @follow_limit)
+      end
+    
+      def process_response(response, follows)
+        response.on_complete do |env|
+          if redirect? response
+            raise RedirectLimitReached, response if follows.zero?
+            env[:url] += response['location']
+            env[:method] = :get
+            response = process_response(@app.call(env), follows - 1)
+          end
+        end
+        response
+      end
+    
+      def redirect?(response)
+        REDIRECTS.include? response.status
+      end
+    end
+  end
+end

data/lib/learnsprout/response/parse_json.rb

@@ -0,0 +1,22 @@
+module LearnSprout
+  module Response
+    class ParseJson < Faraday::Response::Middleware
+      def on_complete(env)
+        if respond_to? :parse
+          env[:body] = parse(env[:body]) unless [204,302,304,307].index env[:status]
+        end
+      end
+
+      def parse(body)
+        case body
+        when ''
+          nil
+        else
+          response_hash = ::MultiJson.decode(body)
+
+          #raise LearnSprout::RequestException, response_hash["message"] if response_hash["message"]
+        end
+      end
+    end
+  end
+end

data/lib/learnsprout/school.rb

@@ -0,0 +1,69 @@
+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 

data/lib/learnsprout/section.rb

@@ -0,0 +1,18 @@
+module LearnSprout
+  class Section
+    include LearnSprout::Connection
+
+    attr_accessor :section_id,
+                  :number,
+                  :room
+
+    def initialize(attrs={})
+        @client = attrs["client"]
+        @org_id = attrs["org_id"]
+        @section_id = attrs["id"]
+        @number = attrs["number"]
+        @room = attrs["room"]
+        #TODO: Other attrs
+    end
+  end
+end 

data/lib/learnsprout/student.rb

@@ -0,0 +1,16 @@
+module LearnSprout
+  class Student
+    include LearnSprout::Connection
+
+    attr_accessor :student_id,
+                  :name
+
+    def initialize(attrs={})
+        @client = attrs["client"]
+        @org_id = attrs["org_id"]
+        @student_id = attrs["id"]
+        @name = attrs["name"]
+        #TODO: Other attrs
+    end
+  end
+end 

data/lib/learnsprout/teacher.rb

@@ -0,0 +1,30 @@
+module LearnSprout
+  class Teacher
+    include LearnSprout::Connection
+
+    attr_accessor :teacher_id,
+                  :first_name,
+                  :middle_name,
+                  :last_name,
+                  :title,
+                  :number,
+                  :time_updated,
+                  :email
+
+    #TODO Other fields
+
+    def initialize(attrs={})
+        @client = attrs["client"]
+        @org_id = attrs["org_id"]
+        @teacher_id = attrs["id"]
+        @first_name = attrs["first_name"]
+        @middle_name = attrs["middle_name"]
+        @last_name = attrs["last_name"]
+        @title = attrs["title"]
+        @number = attrs["number"]
+        @time_updated = attrs["time_updated"]
+        @email = attrs["email"]
+        #TODO: Other attrs
+    end
+  end
+end 

data/lib/learnsprout/term.rb

@@ -0,0 +1,22 @@
+module LearnSprout
+  class Term
+    include LearnSprout::Connection
+
+    attr_accessor :term_id,
+                  :name,
+                  :end_date,
+                  :start_date
+
+    #TODO Other fields
+
+    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
+  end
+end 

data/lib/learnsprout/version.rb

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

data/lib/learnsprout.rb

@@ -0,0 +1,48 @@
+module LearnSprout def self.endpoint=(endpoint)
+    @@endpoint = endpoint
+  end
+
+  def self.endpoint
+    @@endpoint
+  end
+
+  def self.user_agent=(user_agent)
+    @@user_agent = user_agent
+  end
+
+  def self.user_agent
+    @@user_agent
+  end
+
+  def self.debugging?
+    !!@@debug
+  end
+
+  def self.debug=(debug)
+    @@debug = debug
+  end
+
+  self.debug = false
+  self.user_agent = "LearnSprout Ruby Wrapper"
+  self.endpoint = "https://beta.api.learnsprout.com/"
+end
+
+require 'faraday'
+require 'multi_json'
+
+require "learnsprout/exceptions"
+require "learnsprout/response/parse_json"
+require "learnsprout/response/follow_redirects"
+require "learnsprout/connection"
+require "learnsprout/client"
+require "learnsprout/org"
+require "learnsprout/school"
+require "learnsprout/student"
+require "learnsprout/section"
+require "learnsprout/teacher"
+require "learnsprout/term"
+require "learnsprout/course"
+require "learnsprout/nces"
+require "learnsprout/phone"
+require "learnsprout/address"
+require "learnsprout/version"