school_loop 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07ac5da7b48f65a5d323294763459397ec01ebe6
+  data.tar.gz: c019c80fbdc560ac6810f163d251e8a6e6d76dc0
+SHA512:
+  metadata.gz: b41f0caca0c1850d4ccc4415265d91fd6084e1cf51873fb8a5205991fdb31ceced125b83a75780333fcab1534314715a5accf87f96d3de781edf8afa7b55ab56
+  data.tar.gz: b6d0ed1e89c2aa21318afc7dc45c9a55f2bf9f9201ae296ed01c5f6edcad02f5f8d08649e2e83954307a0457925c3cf228a961a7b911d7851970c3c46d978153

data/.gitignore

@@ -0,0 +1,6 @@
+coverage/
+doc
+.yardoc/
+pkg/
+.env
+roster.xml

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+script: bundle exec rake
+before_install:
+  - gem update --system
+  - gem install bundler

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://www.rubygems.org'
+
+gem 'rake'
+
+group :development do
+  gem 'pry'
+end
+
+group :test do
+  gem 'coveralls'
+  gem 'rspec', '~> 3.3'
+  gem 'simplecov', :require => false
+  gem 'webmock', '>= 1.9'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+PATH
+  remote: .
+  specs:
+    school_loop (0.0.1)
+      faraday (~> 0.9)
+      faraday_middleware (~> 0.9)
+      nokogiri (>= 1.5.2)
+
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    addressable (2.3.8)
+    coderay (1.1.0)
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.0)
+      faraday (>= 0.7.4, < 0.10)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mini_portile (0.6.2)
+    multipart-post (2.0.0)
+    netrc (0.10.3)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.4.2)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.5.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  coveralls
+  pry
+  rake
+  rspec (~> 3.3)
+  school_loop!
+  simplecov
+  webmock (>= 1.9)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Mitch Dempsey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# School Loop API
+
+
+[![Build Status](https://travis-ci.org/webdestroya/school_loop.svg)](https://travis-ci.org/webdestroya/school_loop)
+
+
+## Installation
+
+Install the gem by issuing
+
+```ruby
+gem install school_loop
+```
+
+or put it in your Gemfile and run `bundle install`
+
+```ruby
+gem "school_loop"
+```
+
+## Configuration
+
+These global settings will be used unless specifically overridden by an instance below.
+
+```ruby
+SchoolLoop.configure do |config|
+  config.subdomain  = 'demoschool'
+  config.username   = 'apiuser'
+  config.password   = 'some_api_password'
+  config.adapter    = :net_http
+end
+```
+
+## Usage
+
+Create a new client using the global defaults:
+
+```ruby
+school_loop = SchoolLoop.new
+```
+
+Create a new client instance and override global defaults
+
+```ruby
+school_loop = SchoolLoop.new subdomain: 'demoschool', username: 'apiuser', password: 'some_api_password'
+```
+
+Alternatively, you can configure the School Loop settings by passing a block:
+
+```ruby
+school_loop = SchoolLoop.new do |config|
+  config.subdomain  = 'demoschool'
+  config.username   = 'apiuser'
+  config.password   = 'some_api_password'
+  config.adapter    = :net_http
+end
+```
+
+
+Currently, only three methods are implemented:
+
+#### Get Entire School Roster
+
+```ruby
+roster = school_loop.get_roster
+# returns a Nokogiri::XML::Document
+```
+
+#### Get Teacher Roster
+
+```ruby
+teacher_id = "12345"
+roster = school_loop.get_roster(teacher_id)
+# returns a Nokogiri::XML::Document (with a single 'teacher' node)
+```
+
+Example roster data is available on [School Loop's Documentation](http://www.schoolloop.com/about-us/partners/progress-report-api/progress-report-api-schema/#ProgressReportSchema-IVSampleSchoolLoopRosterDownload)
+
+#### Posting Progress Reports
+
+For a detailed schema for Progress reports, you can look at [School Loop's Progress Report API Schema](http://www.schoolloop.com/about-us/partners/progress-report-api/progress-report-api-schema/)
+
+```ruby
+prog_report_xml = <<-EOF
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+  <sections>
+    <section ID="1234">
+      <progressReports>
+        <progressReport markName="Current Grades" ... grade="A">
+          ...
+        </progressReport>
+      </progressReports>
+    </section>
+  </sections>
+</root>
+EOF
+
+school_loop.publish_progress_report(prog_report_xml)
+```
+
+## License
+[MIT](http://opensource.org/licenses/MIT)
+
+## Special Thanks
+This gem is heavily based on the [bitbucket_rest_api](https://github.com/vongrippen/bitbucket) gem by Mike Cochran.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/school_loop.rb

@@ -0,0 +1,25 @@
+require 'school_loop/version'
+require 'school_loop/configuration'
+require 'school_loop/connection'
+require 'school_loop/client'
+
+module SchoolLoop
+  extend Configuration
+
+  class << self
+    def new(options = {}, &block)
+      SchoolLoop::Client.new(options, &block)
+    end
+
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+
+
+end

data/lib/school_loop/client.rb

@@ -0,0 +1,39 @@
+require 'school_loop/configuration'
+require 'school_loop/connection'
+require 'school_loop/resources'
+
+module SchoolLoop
+  class Client
+    include Connection
+
+    include Resources::ProgressReports
+    include Resources::Roster
+
+    attr_reader *Configuration::VALID_OPTIONS_KEYS
+
+    # Callback to update global configuration options
+    class_eval do
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        define_method "#{key}=" do |arg|
+          self.instance_variable_set("@#{key}", arg)
+        end
+      end
+    end
+
+    # Creates new API
+    def initialize(options={}, &block)
+      super()
+      setup options
+
+      self.instance_eval(&block) if block_given?
+    end
+
+    def setup(options={})
+      options = SchoolLoop.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+  end
+end

data/lib/school_loop/configuration.rb

@@ -0,0 +1,54 @@
+module SchoolLoop
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :username,
+      :password,
+      :subdomain,
+
+      :secure,
+
+      :adapter,
+      :user_agent,
+      :connection_options,
+      :debug,
+    ].freeze
+
+    DEFAULT_ADAPTER = :net_http
+
+    DEFAULT_USERNAME = nil
+    DEFAULT_PASSWORD = nil
+    DEFAULT_SUBDOMAIN = nil
+
+    DEFAULT_USER_AGENT = "School Loop Ruby API v#{SchoolLoop::VERSION}".freeze
+
+    DEFAULT_CONNECTION_OPTIONS = {}
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def configure
+      yield self
+    end
+
+    def self.extended(base)
+      base.set_defaults
+    end
+
+    def options
+      options = { }
+      VALID_OPTIONS_KEYS.each { |k| options[k] = send(k) }
+      options
+    end
+
+    def set_defaults
+      self.adapter            = DEFAULT_ADAPTER
+      self.user_agent         = DEFAULT_USER_AGENT
+      self.connection_options = DEFAULT_CONNECTION_OPTIONS
+      self.username           = DEFAULT_USERNAME
+      self.subdomain          = DEFAULT_SUBDOMAIN
+      self.password           = DEFAULT_PASSWORD
+      self.secure             = true
+      self.debug              = false
+      self
+    end
+  end
+end

data/lib/school_loop/connection.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'school_loop/response'
+require 'school_loop/response/raise_error'
+require 'school_loop/response/xmlize'
+
+module SchoolLoop
+  module Connection
+    extend self
+
+
+    def connection
+      @connection ||= Faraday.new({url: "#{secure ? 'https' : 'http'}://#{subdomain}.schoolloop.com"}.merge(connection_options)) do |faraday|
+        faraday.request :basic_auth, username, password
+        faraday.headers[:user_agent] = user_agent
+
+        if debug
+          faraday.response :logger
+        end
+
+        faraday.use SchoolLoop::Response::Xmlize,  :content_type => /\bxml$/
+        faraday.use SchoolLoop::Response::RaiseError
+        faraday.adapter adapter
+      end
+    end
+
+  end
+end

data/lib/school_loop/error.rb

@@ -0,0 +1,16 @@
+module SchoolLoop
+  module Error
+    class SchoolLoopError < StandardError
+      attr_reader :response_message, :response_headers
+
+      def initialize(message)
+        super message
+        @response_message = message
+      end
+    end
+  end
+end
+
+require "school_loop/error/service_error"
+require "school_loop/error/bad_request"
+require "school_loop/error/unauthorized"

data/lib/school_loop/error/bad_request.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module SchoolLoop
+  module Error
+    # Raised when School Loop returns the HTTP status code 400
+    class BadRequest < ServiceError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end
+end # BitBucket

data/lib/school_loop/error/service_error.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+module SchoolLoop #:nodoc
+  # Raised when SchoolLoop returns any of the HTTP status codes
+  module Error
+    class ServiceError < SchoolLoopError
+      attr_accessor :http_headers, :http_status, :http_method, :url
+
+      def initialize(env)
+        super(generate_message(env))
+        @http_headers = env[:response_headers]
+        @http_status = env[:status]
+        @http_method = env[:method].to_s.upcase
+        @url = env[:url].to_s
+      end
+
+      def generate_message(env)
+        "#{env[:body]}"
+      end
+    end
+  end # Error
+end # SchoolLoop

data/lib/school_loop/error/unauthorized.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module SchoolLoop #:nodoc
+  # Raised when SchoolLoop returns the HTTP status code 401
+  module Error
+    class Unauthorized < SchoolLoopError
+      def initialize(env)
+        super(env)
+      end
+    end
+  end # Error
+end # SchoolLoop

data/lib/school_loop/resources.rb

@@ -0,0 +1,8 @@
+module SchoolLoop
+  module Resources
+
+  end
+end
+
+require 'school_loop/resources/progress_reports'
+require 'school_loop/resources/roster'

data/lib/school_loop/resources/progress_reports.rb

@@ -0,0 +1,15 @@
+module SchoolLoop
+  module Resources
+    module ProgressReports
+
+      def publish_progress_report(xml_body)
+        connection.post do |req|
+          req.url "/api/progressReports"
+          req.headers['Content-Type'] = "application/xml"
+          req.body = xml_body
+        end
+      end
+
+    end
+  end
+end

data/lib/school_loop/resources/roster.rb

@@ -0,0 +1,18 @@
+module SchoolLoop
+  module Resources
+    module Roster
+
+      # Get the roster for all teachers, or limit to a specific teacher
+      def get_roster(teacher_id = nil)
+        connection.get do |req|
+          req.url "/api/roster"
+
+          if teacher_id
+            req.params['teacher_id'] = teacher_id
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/school_loop/response.rb

@@ -0,0 +1,20 @@
+
+require 'faraday'
+
+module SchoolLoop
+  class Response < Faraday::Response::Middleware
+    CONTENT_TYPE = 'Content-Type'.freeze
+
+    class << self
+      attr_accessor :parser
+    end
+
+    def self.define_parser(&block)
+      @parser = block
+    end
+
+    def response_type(env)
+      env[:response_headers][CONTENT_TYPE].to_s
+    end
+  end
+end

data/lib/school_loop/response/raise_error.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'school_loop/error'
+
+module SchoolLoop
+  class Response::RaiseError < Faraday::Response::Middleware
+
+    def on_complete(env)
+      case env[:status].to_i
+      when 400
+        raise SchoolLoop::Error::BadRequest.new(env)
+      when 401
+        raise SchoolLoop::Error::Unauthorized.new(env)
+      when 400...600
+        raise SchoolLoop::Error::ServiceError.new(env)
+      end
+    end
+
+  end # Response::RaiseError
+end # SchoolLoop

data/lib/school_loop/response/xmlize.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/response_middleware'
+
+module SchoolLoop
+  class Response::Xmlize < ::FaradayMiddleware::ResponseMiddleware
+    dependency 'nokogiri'
+
+    define_parser do |body|
+      ::Nokogiri::XML body
+    end
+
+    def parse(body)
+      case body
+      when ''
+        nil
+      when 'true'
+        true
+      when 'false'
+        false
+      else
+        self.class.parser.call body
+      end
+    end
+  end # Response::Xmlize
+end # SchoolLoop

data/lib/school_loop/version.rb

@@ -0,0 +1,3 @@
+module SchoolLoop
+  VERSION = "0.0.1"
+end

data/school_loop.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'school_loop/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "school_loop"
+  spec.version     = SchoolLoop::VERSION
+  spec.platform    = Gem::Platform::RUBY
+  spec.authors     = ['Mitch Dempsey']
+  spec.email       = ['mitch@mitchdempsey.com']
+  spec.licenses    = ['MIT']
+  spec.homepage    = "https://github.com/webdestroya/school_loop"
+  spec.summary     = "Client for School Loop API (OpenLoop)"
+  spec.description = "Client for School Loop API (OpenLoop)"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  
+  spec.add_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'faraday_middleware', '~> 0.9'
+  #spec.add_dependency 'ox', '~> 2.2.1'
+  spec.add_dependency 'nokogiri', '>= 1.5.2'
+end

data/spec/fixtures/progress_report_submission.xml

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<root>
+    <sections>
+        <section ID="1234">
+            <progressReports>
+                <progressReport markName="Current Grades" date="2007-08-12T22:24:15Z" score="0.95" grade="A" hasScore="true" useWeighting="false" gradebookDate="">
+                    <gradeDefinitions>
+                        <keyValue key="INC" value="INCOMPLETE (not handed in)"/>
+                    </gradeDefinitions>
+                    <categories>
+                        <category hasScore="true" name="Assignment" weight="-1.000" score="0.000"/>
+                    </categories>
+                    <course period="3" systemID="100000881299" name="English"/>
+                    <gradingScale>
+                        <cutoffs>
+                            <cutoff Start="90" Name="A"/>
+                            <cutoff Start="0" Name="F"/>
+                        </cutoffs>
+                    </gradingScale>
+                    <grades>
+                        <grade score="10" excused="false" comment="" grade="B">
+                            <assignment categoryName="Assignment" maxPoints="10" dueDate="2007-05-18T00:00:00Z" title="WWI"/>
+                        </grade>
+                        <grade score="10" excused="false" comment="" grade="B">
+                            <assignment categoryName="Assignment" maxPoints="10" dueDate="2007-05-18T00:00:00Z" title="Thing 2"/>
+                        </grade>
+                    </grades>
+                    <student name="Cleaver, Kevin" schoolID="7123456"/>
+                </progressReport>
+            </progressReports>
+        </section>
+    </sections>
+</root>

data/spec/fixtures/roster_response.xml

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<root>
+  <roster source="schoolloop.com">
+    <teachers>
+      <teacher systemID="1111180131503" localID="111111" name="Reynolds, Mr. Malcom">
+        <courses>
+          <course systemID="1111107012313" name="Math">
+            <periods>
+              <period systemID="1111133312598" number="1">
+                <assignments/>
+                <students>
+                  <student permID="1000265" systemID="1111170083336" gradeLevel="12" firstName="Ryan" middleName="Chris" lastName="Test" displayID="1000265" localID="1234" sectionID="1234" sectionSystemID="1111133311259"/>
+                  <student permID="1000186" systemID="1111170083213" gradeLevel="11" firstName="Manuel" middleName="" lastName="Test" displayID="1000186" localID="5677" sectionID="1234" sectionSystemID="1111133311259"/>
+                  <student permID="1000673" systemID="1111170083137" gradeLevel="11" firstName="Justin" middleName="" lastName="Test" displayID="1000673" localID="8900" sectionID="1234" sectionSystemID="1111133311259"/>
+                  <student permID="1000878" systemID="1111170082883" gradeLevel="11" firstName="Dave" middleName="" lastName="Test" displayID="1000878" localID="1235" sectionID="1234" sectionSystemID="1111133311259"/>
+                  <student permID="1000985" systemID="1111107494444" gradeLevel="12" firstName="Colby" middleName="Jeffrey" lastName="Test" displayID="1000985" localID="1236" sectionID="1234" sectionSystemID="1111133311259"/>
+                </students>
+              </period>
+            </periods>
+          </course>
+          <course systemID="1111107012069" name="English 3">
+            <periods>
+              <period systemID="1111133312700" number="5">
+                <assignments>
+                  <assignment dueDate="2015-08-27T00:00:00Z" maxPoints="10.0" systemID="1111143710574" categoryName="Assignment" title="Parent Signature" categoryID="1111146128059"/>
+                  <assignment dueDate="2015-09-10T00:00:00Z" maxPoints="42.0" systemID="1111124172130" categoryName="Assignment" title="Unit 1 Literary Terms Worksheet and Test" categoryID="1111146128059"/>
+                  <assignment dueDate="2015-10-02T00:00:00Z" maxPoints="100.0" systemID="1111124171925" categoryName="Assignment" title="Participation/Professionalism" categoryID="1111146128059"/>
+                </assignments>
+                <students>
+                  <student permID="1000338" systemID="1111170083144" gradeLevel="11" firstName="Henny" middleName="" lastName="Test" displayID="1000338" localID="123" sectionID="1000" sectionSystemID="1111133311919"/>
+                  <student permID="1000997" systemID="1111170083020" gradeLevel="11" firstName="Sean" middleName="" lastName="Test" displayID="1000997" localID="456" sectionID="1000" sectionSystemID="1111133311919"/>
+                  <student permID="1000673" systemID="1111170083137" gradeLevel="11" firstName="Justin" middleName="" lastName="Test" displayID="1000673" localID="789" sectionID="1000" sectionSystemID="1111133311919"/>
+                  <student permID="1000828" systemID="1111143756226" gradeLevel="11" firstName="Fred" middleName="Adele" lastName="Test" displayID="1000828" localID="8456" sectionID="1000" sectionSystemID="1111133311919"/>
+                  <student permID="1000977" systemID="1111170082757" gradeLevel="11" firstName="Peter" middleName="Jay" lastName="Test" displayID="1000977" localID="9456" sectionID="1000" sectionSystemID="1111133311919"/>
+                  <student permID="1000183" systemID="1111170083015" gradeLevel="11" firstName="Kyle" middleName="Kend" lastName="Test" displayID="1000183" localID="7456" sectionID="1000" sectionSystemID="1111133311919"/>
+                </students>
+              </period>
+            </periods>
+          </course>
+        </courses>
+        <categories>
+          <category systemID="1111146879613" name="Classwork - Homework"/>
+          <category systemID="1111146128059" name="Assignment"/>
+          <category systemID="1111175461981" name="Quiz / Test"/>
+        </categories>
+      </teacher>
+    </teachers>
+  </roster>
+</root>

data/spec/helper.rb

@@ -0,0 +1,28 @@
+if RUBY_ENGINE == 'ruby'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start
+end
+
+require 'school_loop'
+require 'rspec'
+require 'webmock/rspec'
+
+WebMock.disable_net_connect!(:allow => 'coveralls.io')
+
+RSpec.configure do |config|
+  config.raise_errors_for_deprecations!
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

data/spec/school_loop/client_spec.rb

@@ -0,0 +1,84 @@
+require 'helper'
+
+describe SchoolLoop::Client do
+
+
+
+
+  describe "error handling" do
+
+    let(:unauth_client) do
+      SchoolLoop.new do |config|
+        config.subdomain  = 'subdomain'
+        config.username   = 'username'
+        config.password   = 'password'
+        config.adapter    = :net_http
+      end
+    end
+
+    # bad user, good password
+    # 401 ERROR: Authorization failed: user or role not privileged.
+
+    # bad user, bad password
+    # 401 ERROR: Authorization failed: password incorrect.
+
+    # api not enabled
+    # 400 Error: OpenLoop is not enabled for subdomain.schoolloop.com. Contact School Loop.
+
+
+    context "401 Unauthorized" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/)
+          .to_return(status: 401, body: "ERROR: Authorization failed: password incorrect.")
+      end
+      it "raises an exception" do
+        expect { unauth_client.get_roster }.to raise_error(SchoolLoop::Error::Unauthorized)
+      end
+    end
+
+    context "400 Bad Request" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/)
+          .to_return(status: 400, body: "some error message")
+      end
+
+      it "raises an exception" do
+        expect { unauth_client.get_roster }.to raise_error(SchoolLoop::Error::BadRequest, "some error message")
+      end
+    end
+
+    context "404" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/)
+          .to_return(status: 404, body: "not found")
+      end
+
+      it "raises an exception" do
+        expect { unauth_client.get_roster }.to raise_error(SchoolLoop::Error::ServiceError, "not found")
+      end
+    end
+
+    context "503" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/)
+          .to_return(status: 503, body: "backend failure")
+      end
+
+      it "raises an exception" do
+        expect { unauth_client.get_roster }.to raise_error(SchoolLoop::Error::ServiceError, "backend failure")
+      end
+    end
+
+    context "timeout" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/).to_timeout
+      end
+
+      it "raises an exception" do
+        expect { unauth_client.get_roster }.to raise_error(Faraday::TimeoutError)
+      end
+    end
+
+
+  end
+end

data/spec/school_loop/configuration_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+describe SchoolLoop::Configuration do
+
+  describe ".configure" do
+
+    it "sets global configuration settings" do
+      SchoolLoop.configure do |config|
+        config.username = "test2"
+        config.password = "setting2"
+      end
+
+      expect(SchoolLoop.options[:username]).to eq "test2"
+      expect(SchoolLoop.options[:password]).to eq "setting2"
+
+      client = SchoolLoop.new
+
+      expect(client.username).to eq "test2"
+      expect(client.password).to eq "setting2"
+    end
+
+    it "allows the user to specify extra config options" do
+      SchoolLoop.configure do |config|
+        config.connection_options = {ssl: {verify: false}, request: {timeout: 1234}}
+      end
+
+      client = SchoolLoop.new
+      expect(client.connection.options.timeout).to eq 1234
+    end
+
+    describe ":secure" do
+      it { expect(SchoolLoop.new(secure: false, subdomain: "test").connection.url_prefix.scheme).to eq "http" }
+
+      it { expect(SchoolLoop.new(secure: true, subdomain: "test").connection.url_prefix.scheme).to eq "https" }
+      it { expect(SchoolLoop.new(subdomain: "test").connection.url_prefix.scheme).to eq "https" }
+    end
+
+  end
+
+
+end

data/spec/school_loop/resources/progress_reports_spec.rb

@@ -0,0 +1,39 @@
+require 'helper'
+
+describe SchoolLoop::Resources::ProgressReports do
+
+  let(:client) do
+    SchoolLoop.new do |config|
+      config.subdomain  = 'subdomain'
+      config.username   = 'username'
+      config.password   = 'password'
+      config.adapter    = :net_http
+    end
+  end
+
+  describe "#publish_progress_report" do
+
+    it "publishes a progress report" do
+      stub_request(:post, "https://username:password@subdomain.schoolloop.com/api/progressReports")
+        .to_return(status: 200, body: "SUCCESS\n")
+
+      response = client.publish_progress_report("<xml/>")
+      expect(a_request(:post, /.*subdomain\.schoolloop\.com\/api\/progressReports/)).to have_been_made.once
+
+      expect(response.status).to eq 200
+      expect(response.body).to eq "SUCCESS\n"
+    end
+
+    context "errors" do
+      before(:each) do
+        stub_request(:any, /.*schoolloop\.com\/.*/)
+          .to_return(status: 400, body: "Error: failed to parse XML reports. No reports found. Check XML syntax.")
+      end
+
+
+      it { expect { client.publish_progress_report("<xml/>") }.to raise_error(SchoolLoop::Error::BadRequest) }
+      it { expect { client.publish_progress_report("<xml/>") }.to raise_error("Error: failed to parse XML reports. No reports found. Check XML syntax.") }
+    end
+
+  end
+end

data/spec/school_loop/resources/roster_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+describe SchoolLoop::Resources::Roster do
+
+  let(:client) do
+    SchoolLoop.new do |config|
+      config.subdomain  = 'subdomain'
+      config.username   = 'username'
+      config.password   = 'password'
+      config.adapter    = :net_http
+    end
+  end
+
+  describe "#get_roster" do
+
+    before do
+      stub_request(:get, /.*schoolloop\.com\/api\/roster.*/)
+        .to_return(status: 200, body: fixture("roster_response.xml").read,
+          headers: {'Content-Type' => 'text/xml'}
+        )
+    end
+
+    it "for entire school" do
+      response = client.get_roster
+      expect(a_request(:get, /.*subdomain\.schoolloop\.com\/api\/roster/)).to have_been_made.once
+
+      expect(response.status).to eq 200
+      expect(response.body).to be_a Nokogiri::XML::Document
+      expect(response.body.xpath("//root/roster/teachers/teacher")[0].attr("name")).to eq "Reynolds, Mr. Malcom"
+    end
+
+    it "for a specific teacher" do
+      response = client.get_roster("12345")
+      expect(a_request(:get, /.*subdomain\.schoolloop\.com\/api\/roster/).with(query: {teacher_id: "12345"})).to have_been_made.once
+
+      expect(response.status).to eq 200
+      expect(response.body).to be_a Nokogiri::XML::Document
+      expect(response.body.xpath("//root/roster/teachers/teacher")[0].attr("name")).to eq "Reynolds, Mr. Malcom"
+    end
+  end
+end

data/spec/school_loop_spec.rb

@@ -0,0 +1,64 @@
+require 'helper'
+
+describe SchoolLoop do
+
+  describe ".new" do
+
+    it "allows an instance to override the global configuration" do
+      SchoolLoop.configure do |config|
+        config.username = "test2"
+        config.password = "setting2"
+      end
+
+      client = SchoolLoop.new
+
+      expect(client.username).to eq "test2"
+      expect(client.password).to eq "setting2"
+
+      client2 = SchoolLoop.new(username: "test3", password: "setting3")
+      expect(client2.username).to eq "test3"
+      expect(client2.password).to eq "setting3"
+
+      expect(client.username).to eq "test2"
+      expect(client.password).to eq "setting2"
+
+      client3 = SchoolLoop.new(username: "test4")
+      expect(client3.username).to eq "test4"
+    end
+
+    it "does not modify the global configuration" do
+      SchoolLoop.configure do |config|
+        config.username = "testg"
+        config.password = "passg"
+      end
+
+      client = SchoolLoop.new(username: "gtest", password: "gpass")
+
+      expect(client.username).to eq "gtest"
+      expect(client.password).to eq "gpass"
+
+      expect(SchoolLoop.options[:username]).to eq "testg"
+      expect(SchoolLoop.options[:password]).to eq "passg"
+    end
+  end
+
+
+  describe ".method_missing" do
+    let(:client_dbl) { double(SchoolLoop::Client) }
+
+    before do
+      allow(SchoolLoop).to receive(:new).and_return(client_dbl)
+    end
+
+    it "creates an instance and calls the method" do
+      expect(client_dbl).to receive(:get_roster).with("1234").and_return(true)
+      expect(SchoolLoop.get_roster("1234")).to be_truthy
+    end
+  end
+
+  describe ".respond_to?" do
+    it { expect(SchoolLoop).to respond_to(:get_roster) }
+    it { expect(SchoolLoop).to respond_to(:publish_progress_report) }
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: school_loop
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mitch Dempsey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: Client for School Loop API (OpenLoop)
+email:
+- mitch@mitchdempsey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/school_loop.rb
+- lib/school_loop/client.rb
+- lib/school_loop/configuration.rb
+- lib/school_loop/connection.rb
+- lib/school_loop/error.rb
+- lib/school_loop/error/bad_request.rb
+- lib/school_loop/error/service_error.rb
+- lib/school_loop/error/unauthorized.rb
+- lib/school_loop/resources.rb
+- lib/school_loop/resources/progress_reports.rb
+- lib/school_loop/resources/roster.rb
+- lib/school_loop/response.rb
+- lib/school_loop/response/raise_error.rb
+- lib/school_loop/response/xmlize.rb
+- lib/school_loop/version.rb
+- school_loop.gemspec
+- spec/fixtures/progress_report_submission.xml
+- spec/fixtures/roster_response.xml
+- spec/helper.rb
+- spec/school_loop/client_spec.rb
+- spec/school_loop/configuration_spec.rb
+- spec/school_loop/resources/progress_reports_spec.rb
+- spec/school_loop/resources/roster_spec.rb
+- spec/school_loop/response/xmlize_spec.rb
+- spec/school_loop_spec.rb
+homepage: https://github.com/webdestroya/school_loop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Client for School Loop API (OpenLoop)
+test_files:
+- spec/fixtures/progress_report_submission.xml
+- spec/fixtures/roster_response.xml
+- spec/helper.rb
+- spec/school_loop/client_spec.rb
+- spec/school_loop/configuration_spec.rb
+- spec/school_loop/resources/progress_reports_spec.rb
+- spec/school_loop/resources/roster_spec.rb
+- spec/school_loop/response/xmlize_spec.rb
+- spec/school_loop_spec.rb