engrade 1.0.0

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/fixtures
+config/environment.rb

data/.rvmrc

@@ -0,0 +1 @@
+rvm use default@engrade

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in engrade.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color -fd" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,29 @@
+# Engrade::Ruby
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'engrade-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install engrade-ruby
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+task :default => :spec

data/config/environment.rb.template

@@ -0,0 +1,4 @@
+ENV['ENG_USER'] = 'username
+ENV['ENG_PASS'] = 'password'
+ENV['ENG_API'] = 'apikey'
+ENV['ENG_SES'] = 'sample ses token'

data/engrade.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'engrade/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "engrade"
+  gem.version       = Engrade::VERSION
+  gem.authors       = ["Zachary Thompson"]
+  gem.email         = ["zgthompson@gmail.com"]
+  gem.description   = %q{Basic ruby wrapper for the Engrade API}
+  gem.summary       = %q{Utilize the Engrade API easily through Ruby}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'rest-client'
+  gem.add_runtime_dependency 'mechanize'
+  gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'factory_girl'
+  gem.add_development_dependency 'rb-inotify'
+end

data/lib/engrade.rb

@@ -0,0 +1,141 @@
+require 'rest_client'
+require 'json'
+require_relative 'engrade/version'
+require_relative 'engrade/exceptions'
+require_relative 'engrade/return_types'
+require_relative 'engrade/browser'
+
+module Engrade
+
+  ###########################
+  # VARIABLES AND CONSTANTS #
+  ###########################
+  #
+  @default_params = { :api => 'json' }
+  @browser = Engrade::Browser.new
+
+  def self.base_uri; 'https://api.engrade.com/api/' end 
+
+  ###########################
+  # GETTERS AND (RE)SETTERS #
+  ###########################
+
+  # default_params are included in all post requests
+  def self.default_params; @default_params end
+
+
+  # browser is used to extend the engrade api to allow for the removal of
+  # assignment comments
+  def self.browser; @browser end
+  
+
+  def self.reset!
+    @default_params = { :api => 'json' }
+  end
+
+
+  def self.set_ses(ses)
+    @default_params.store :ses, ses
+  end
+
+  ######################
+  # CORE FUNCTIONALITY #
+  ######################
+  
+  # .post takes merges the default_params with query, a hash of input fields,
+  # and posts them to the api
+  # Example: 
+  # Engrade.post({:apitask => 'login', :usr => 'myusername', :pwd => 'secret'})
+  def self.post(query={})
+    response = RestClient.post base_uri, query.merge(@default_params)
+    raise InvalidKey, 'Invalid apikey' if response.match("Invalid apikey")
+    raise MissingTask, 'No apitask specified' if response.match("No apitask specified")
+    raise InvalidTask, 'Invalid apitask' if response.match("Invalid apitask")
+    raise InvalidSession, 'Not logged in' if response.match("Not logged in")
+    response
+  end
+
+
+  def self.set_apikey(key)
+    @default_params.store :apikey, key
+  end
+
+
+  # .login posts a valid username and password to the api, and stores the
+  # responding session token in default_params
+  def self.login(u, p)
+    response = post :apitask => 'login', :usr => u, :pwd => p
+    raise InvalidLogin, 'Invalid username/password' if response.
+      match(/Invalid (username|password)/)
+    @browser.login u, p
+    @default_params.store :ses, JSON(response)['values']['ses']
+  end
+
+  
+  # .classes returns an array of Classroom objects(data structure to represent
+  # classes). if called with a regexp, it will only return the classes whose
+  # name matches that regexp. if called with no argument, it will return all
+  # classes.
+  def self.classes(regexp=nil)
+    classes = teacher_classes
+    classes.select! { |cl| cl['name'].match regexp } if regexp
+    classes.map { |cl| Classroom.new(cl) }
+  end
+
+
+  # .assignments returns an array(of Assignment objects) of every assignment
+  # from the input classes. the classes parameter can be the class id, a
+  # Classroom object, an array of class ids, or an array of Classroom objects.
+  def self.assignments(classes)
+    assignments = []
+    clid_array(classes).each do |clid|
+      (Engrade.gradebook :clid => clid).
+        map { |assn| assignments << Assignment.new(assn) }
+    end
+    assignments
+  end
+
+
+  # .delete takes in an array of Assignment object, or a single Assignment
+  # object and deletes those assignments from the Engrade webpage. it also
+  # removes the comments from those assignments before deleting, because of
+  # a bug in the Engrade system where comments from deleted assignments
+  # reappear when assignment ids are recycled.
+  def self.delete(assignments)
+    assignments = array(assignments)
+    assignments.each do |assn|
+      @browser.remove_comments assn.clid, assn.assnid
+      post :apitask => 'assignment-edit', :clid => assn.clid, :assnid => assn.assnid, :delete => '1'
+    end
+  end
+
+  ##################
+  # HELPER METHODS #
+  ##################
+
+  def self.teacher_classes(query={})
+    JSON(post :apitask => 'teacher-classes')['classes']
+  end
+
+
+  def self.gradebook(query={})
+    response = post({ :apitask => 'gradebook' }.merge query)
+    raise InvalidClassId, 'Invalid class' if response.
+      match("You are not authorized to view this class")
+    JSON(response)['assignments']
+  end
+
+
+  def self.array(input)
+    input = input.instance_of?(Array) ? input : [input]
+  end
+
+
+  def self.clid_array(classes)
+    classes =  array(classes)
+    classes.map! { |cl| cl.clid } if classes.first.instance_of? Classroom 
+    classes
+  end
+
+end
+

data/lib/engrade/browser.rb

@@ -0,0 +1,28 @@
+require 'mechanize'
+
+module Engrade
+
+  class Browser
+
+    def initialize
+      @agent
+    end
+
+    def login(u, p)
+      @agent = Mechanize.new
+      form = @agent.get('https://www.engrade.com/user/login.php').forms.first
+      form.usr = u
+      form.pwd = p
+      @agent.submit(form)
+    end
+
+    def remove_comments(clid, assnid)
+      page = @agent.get "https://www.engrade.com/class/assignments/edit.php?assnid=#{assnid}&clid=#{clid}"
+      scores = page.form.fields_with(:name => /^score/)
+      scores.each { |score| score.value = "" }
+      @agent.submit(page.form)
+    end
+
+  end
+
+end

data/lib/engrade/exceptions.rb

@@ -0,0 +1,11 @@
+module Engrade
+
+  class InvalidKey < StandardError; end
+  class InvalidLogin < StandardError; end
+  class InvalidSession < StandardError; end
+  class MissingTask < StandardError; end
+  class InvalidTask < StandardError; end
+  class InvalidClassId < StandardError; end
+
+end
+

data/lib/engrade/return_types.rb

@@ -0,0 +1,8 @@
+require 'ostruct'
+
+module Engrade
+
+  class Classroom < OpenStruct; end
+  class Assignment < OpenStruct; end
+
+end

data/lib/engrade/version.rb

@@ -0,0 +1,3 @@
+module Engrade
+    VERSION = "1.0.0"
+end

data/spec/engrade_spec.rb

@@ -0,0 +1,359 @@
+require_relative 'spec_helper'
+
+describe Engrade do
+
+  after :each do
+    Engrade.reset!
+  end
+
+  it "should have base_uri set to engrade api endpoint" do
+    Engrade.base_uri.should eql 'https://api.engrade.com/api/'
+  end
+
+  describe "public method" do
+
+    describe ".default_params" do
+      
+      it "should be a Hash" do
+        Engrade.default_params.should be_an_instance_of Hash
+      end
+
+      it "should have :api set to json" do
+        Engrade.default_params[:api].should eql 'json'
+      end
+
+    end
+
+    describe ".set_apikey" do
+
+      it "should set :apikey in default_params" do
+        Engrade.set_apikey 'test'
+        Engrade.default_params[:apikey].should eql 'test'
+      end
+
+    end
+
+    describe ".set_ses" do
+
+      it "should set :ses in default_params" do
+        Engrade.set_ses 'test'
+        Engrade.default_params[:ses].should eql 'test'
+      end
+
+    end
+
+    describe ".reset!" do
+
+      it "should reset default_params to original value" do
+        orig = Engrade.default_params.dup
+        Engrade.set_apikey "12345"
+        Engrade.reset!
+        Engrade.default_params.should eql orig
+      end
+
+    end
+
+    describe ".post" do
+
+      before :each do
+        Engrade.set_apikey ENV['ENG_API']
+      end
+
+      it "should call RestClient.post with query and default_params" do
+        response = build :login
+        RestClient.should_receive(:post).with(Engrade.base_uri, response[:payload]).
+          and_return response[:body]
+        Engrade.post response[:query]
+      end
+
+      context "with valid call" do
+
+        it "should return the result of RestClient.post" do
+          response = build :login
+          RestClient.stub(:post).and_return response[:body]
+          Engrade.post(response[:query]).should eql response[:body]
+        end
+
+      end
+
+      context "when not logged in" do
+
+        it "should raise an InvalidSession error" do
+          RestClient.stub(:post).and_return build(:bad_ses)[:body]
+          expect { Engrade.post :apitask => 'teacher-classes' }.
+            to raise_error Engrade::InvalidSession
+        end
+
+      end
+
+      context "with bad apikey" do
+
+        it "should raise an InvalidKey error" do
+          Engrade.set_apikey 'badapi'
+          RestClient.stub(:post).and_return build(:bad_api)[:body]
+          expect { Engrade.post }.to raise_error Engrade::InvalidKey
+        end
+
+      end
+
+      context "with no apitask specified" do
+
+        it "should raise a MissingTask error" do
+          RestClient.stub(:post).and_return build(:no_task)[:body]
+          expect { Engrade.post }.to raise_error Engrade::MissingTask
+        end
+
+      end
+
+      context "with invalid apitask specified" do
+
+        it "should raise an InvalidTask error" do
+          RestClient.stub(:post).and_return build(:bad_task)[:body]
+          expect { Engrade.post :apitask => 'badtask' }.
+            to raise_error Engrade::InvalidTask
+        end
+      
+      end
+
+    end
+
+    describe ".login" do
+
+      before :each do
+        Engrade.browser.stub :login
+      end
+
+      it "should call .post with query Hash" do
+        response = build :login
+        Engrade.should_receive(:post).with(response[:query]).
+          and_return response[:body]
+        Engrade.login ENV['ENG_USER'], ENV['ENG_PASS']
+      end
+
+      context "with valid credentials" do
+
+        before :each do
+          @response = build(:login)
+          Engrade.stub(:post).and_return @response[:body]
+        end
+
+        it "should return the session id" do
+          Engrade.login(ENV['ENG_USER'], ENV['ENG_PASS']).
+            should eql @response[:json]['values']['ses']
+        end
+
+        it "should set :ses in the default params" do
+          ses = Engrade.login ENV['ENG_USER'], ENV['ENG_PASS']
+          Engrade.default_params[:ses].should eql ses
+        end
+
+      end
+
+      context "with invalid username" do
+
+        it "should raise InvalidLogin error" do
+          Engrade.stub(:post).and_return build(:login_baduser)[:body]
+          expect { Engrade.login 'baduser', 'anypass' }.to raise_error Engrade::InvalidLogin
+        end
+
+      end
+
+      context "with invalid password" do
+        
+        it "should raise InvalidLogin error" do
+          Engrade.stub(:post).and_return build(:login_badpass)[:body]
+          expect { Engrade.login ENV['ENG_USER'], 'badpass' }.to raise_error Engrade::InvalidLogin
+        end
+
+      end
+
+    end
+
+    describe ".classes" do
+
+      before :each do
+        @classes = build(:teacher_classes)[:classes]
+        Engrade.stub(:teacher_classes).and_return @classes
+      end
+
+
+      it "should call .teacher_classes with the proper query" do
+        Engrade.should_receive(:teacher_classes).with(no_args).
+          and_return @classes
+        Engrade.classes
+      end
+
+
+      describe "return value" do
+
+        it "should be an Array" do
+          Engrade.classes.should be_an_instance_of Array
+        end
+
+        it "should contain Classroom objects" do
+          Engrade.classes.first.should be_an_instance_of Engrade::Classroom
+        end
+
+        it "should be filtered when given a string argument" do
+          Engrade.classes.size.should be > Engrade.classes("Sem1").size
+        end
+
+        it "should contain classes that match the string argument" do
+          Engrade.classes("Sem1").first.name.should match "Sem1"
+        end
+
+      end
+
+    end
+
+    describe ".assignments" do
+
+      before :each do
+        @response = build :gradebook
+        Engrade.stub(:gradebook).and_return @response[:assignments]
+      end
+
+      it "should take a class id as input" do
+        expect { Engrade.assignments((build :classroom).clid) }.to_not raise_error
+      end
+
+      it "should take a classroom object as input" do
+        expect { Engrade.assignments(build :classroom) }.to_not raise_error
+      end
+
+      it "should take an array of classroom objects as input" do
+        expect { Engrade.assignments [build(:classroom), build(:classroom)] }.
+          to_not raise_error
+      end
+
+      it "should take an array of clids as input" do
+        expect { Engrade.assignments [(build :classroom).clid, (build :classroom).clid] }.
+          to_not raise_error
+      end
+
+      it "should call .gradebook for each class from input array" do
+        classes = [build(:classroom), build(:classroom)]
+        Engrade.should_receive(:gradebook).exactly(2).times
+        Engrade.assignments classes
+      end
+
+
+      it "should call .gradebook with the appropriate query" do
+        Engrade.should_receive(:gradebook).with @response[:public_query]
+        Engrade.assignments build(:classroom)
+      end
+
+
+      describe "return value" do
+
+        it "should be an Array" do
+          Engrade.assignments(build :classroom).should be_an_instance_of Array
+        end
+
+        it "should contain Assignment objects" do
+          Engrade.assignments(build :classroom).first.
+            should be_an_instance_of Engrade::Assignment
+        end
+
+        it "should contain assigments from all input classes" do
+          Engrade.assignments(build :classroom).size.should be < Engrade.assignments([build(:classroom), build(:classroom)]).size
+        end
+
+      end
+
+    end
+
+    describe ".delete" do
+
+      before :each do
+        Engrade.set_ses ENV['ENG_SES']
+        Engrade.stub :post
+        Engrade.browser.stub :remove_comments
+      end
+
+      it "should accept an array of Assignments as input" do
+        assignments = [build(:assignment), build(:assignment)]
+        expect { Engrade.delete assignments }.to_not raise_error
+      end
+
+      it "should accept a single Assignment as input" do
+        assignment = build :assignment
+        expect { Engrade.delete assignment }.to_not raise_error
+      end
+
+      it "should remove comments of every assignment" do
+        assignments = [build(:assignment), build(:assignment)]
+        Engrade.browser.should_receive(:remove_comments).exactly(2).times
+        Engrade.delete assignments
+      end
+
+      it "should call .post with proper query" do
+        Engrade.should_receive(:post).with build(:delete)[:query]
+        Engrade.delete [build(:assignment)]
+      end
+      
+    end
+
+  end
+
+  describe "helper method" do
+
+
+    describe ".teacher_classes" do
+
+    before :each do
+      Engrade.set_apikey ENV['ENG_API']
+      Engrade.set_ses ENV['ENG_SES']
+      @response = build :teacher_classes
+      Engrade.stub :classes
+    end
+
+      it "should call .post with the proper query" do
+        Engrade.should_receive(:post).with(@response[:helper_query]).
+          and_return @response[:body]
+        Engrade.teacher_classes
+      end
+
+      it "should return an array of classes" do
+        Engrade.stub(:post).and_return @response[:body]
+        Engrade.teacher_classes.should eql @response[:classes]
+      end
+
+    end
+
+    describe ".gradebook" do
+
+      before :each do
+        Engrade.set_apikey ENV['ENG_API']
+        Engrade.set_ses ENV['ENG_SES']
+        @response = build :gradebook
+        Engrade.stub :assignments
+      end
+
+      it "should call .post with appropriate query" do
+        Engrade.should_receive(:post).with(@response[:helper_query]).
+          and_return @response[:body]
+        Engrade.gradebook :clid => build(:classroom).clid
+      end
+
+      it "should return an array of assignments" do
+        Engrade.stub(:post).and_return @response[:body]
+        Engrade.gradebook(:clid => build(:classroom).clid).
+          should eql @response[:assignments]
+      end
+        
+      context "with bad class id" do
+
+        it "should raise a InvalidClassId error" do
+          Engrade.stub(:post).and_return build(:bad_class)[:body]
+          expect { Engrade.gradebook(:clid => build(:bad_classroom).clid) }.
+            to raise_error Engrade::InvalidClassId
+        end
+
+      end
+
+    end
+  
+  end
+
+end

data/spec/factories/assignment_factory.rb

@@ -0,0 +1,10 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+
+  factory :assignment, class:Engrade::Assignment do
+    clid "101"
+    assnid "1"
+  end
+
+end

data/spec/factories/classroom_factory.rb

@@ -0,0 +1,13 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+
+  factory :classroom, class:Engrade::Classroom do
+    clid "101"
+  end
+
+  factory :bad_classroom, class:Engrade::Classroom do
+    clid "123456"
+  end
+
+end

data/spec/factories/response_factory.rb

@@ -0,0 +1,96 @@
+require 'factory_girl'
+
+FactoryGirl.define do
+  
+  factory :login, class:Hash do
+    body "{\"fields\":\"usr pwd remember go\",\"success\":true,\"values\":{\"usr\":\"zgthompson\",\"pwd\":\"secretpass\",\"remember\":null,\"go\":null,\"ses\":\"9426016804785795792n8k42bbalb40m8e58j4n0faa98d03o0958kfmn98019pa\"},\"time\":1363650224}" 
+    json { JSON(body) }
+    query { { :usr => ENV['ENG_USER'], :pwd => ENV['ENG_PASS'], :apitask => 'login' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] }.merge query }
+
+    initialize_with { attributes }
+  end
+
+  factory :login_baduser, class:Hash do
+    body "{\"fields\":\"usr pwd remember go\",\"success\":false,\"values\":{\"usr\":\"baduser\",\"pwd\":\"anypass\",\"remember\":null,\"go\":null},\"errors\":{\"usr\":\"Invalid username\"},\"time\":1363653753}"
+    json { JSON(body) }
+    query { { :usr => 'baduser', :pwd => 'anypass', :apitask => 'login' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] }.merge query }
+    
+    initialize_with { attributes }
+  end
+
+  factory :login_badpass, class:Hash do
+    body "{\"fields\":\"usr pwd remember go\",\"success\":false,\"values\":{\"usr\":\"zgthompson\",\"pwd\":\"badpass\",\"remember\":null,\"go\":null},\"errors\":{\"pwd\":\"Invalid password\"},\"time\":1363654455}" 
+    json { JSON(body) }
+    query { { :usr => 'zgthompson', :pwd => 'badpass', :apitask => 'login' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] }.merge query }
+    
+    initialize_with { attributes }
+  end
+
+  factory :bad_api, class:Hash do
+    body "Invalid apikey, please contact Engrade to receive your API key.badapi" 
+    query { {} }
+    payload { { :api => 'json', :apikey => 'badapi' } }
+    
+    initialize_with  { attributes }
+  end
+
+  factory :teacher_classes, class:Hash do
+    body "{\"success\":true,\"classes\":[{\"superid\":\"1000008059883\",\"subid\":\"101\",\"supertype\":\"teacher\",\"subtype\":\"class\",\"auth\":6,\"joined\":1361653042,\"role\":\"Teacher\",\"clid\":\"101\",\"created\":1361653042,\"folder\":3,\"syr\":\"2013-2014\",\"gp\":1,\"gscale\":9,\"weighted\":0,\"showper\":1,\"stusort\":1,\"assnsort\":1,\"round\":1,\"stuview\":1,\"stumail\":0,\"gradelevel\":7,\"subject\":5,\"bb\":0,\"teachmail\":1,\"priteach\":\"1000008059883\",\"name\":\"Biology\",\"code\":null,\"stucount\":6,\"average\":68.3,\"missing\":0,\"failing\":1,\"registered\":0,\"acount\":1,\"stdset\":0,\"updated\":1362535927},{\"superid\":\"1000008059883\",\"subid\":\"5000006291841\",\"supertype\":\"teacher\",\"subtype\":\"class\",\"auth\":6,\"joined\":1363580907,\"role\":\"Teacher\",\"clid\":\"5000006291841\",\"created\":1363580907,\"folder\":3,\"syr\":\"2013-2014\",\"gp\":1,\"gscale\":9,\"weighted\":0,\"showper\":1,\"stusort\":1,\"assnsort\":1,\"round\":1,\"stuview\":1,\"stumail\":0,\"gradelevel\":99,\"subject\":99,\"bb\":0,\"teachmail\":1,\"priteach\":\"1000008059883\",\"name\":\"Chemistry - Sem1\",\"code\":null,\"stucount\":2,\"average\":0,\"missing\":0,\"failing\":0,\"registered\":0,\"acount\":0,\"stdset\":0,\"updated\":1363580917},{\"superid\":\"1000008059883\",\"subid\":\"5000006291845\",\"supertype\":\"teacher\",\"subtype\":\"class\",\"auth\":6,\"joined\":1363580934,\"role\":\"Teacher\",\"clid\":\"5000006291845\",\"created\":1363580934,\"folder\":3,\"syr\":\"2013-2014\",\"gp\":1,\"gscale\":9,\"weighted\":0,\"showper\":1,\"stusort\":1,\"assnsort\":1,\"round\":1,\"stuview\":1,\"stumail\":0,\"gradelevel\":99,\"subject\":99,\"bb\":0,\"teachmail\":1,\"priteach\":\"1000008059883\",\"name\":\"Math - Sem2\",\"code\":null,\"stucount\":2,\"average\":0,\"missing\":0,\"failing\":0,\"registered\":0,\"acount\":0,\"stdset\":0,\"updated\":1363580941}],\"time\":1363655149}"
+    json { JSON(body) }
+    classes { json['classes'] }
+    helper_query { { :apitask => 'teacher-classes' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'], :ses => ENV['ENG_SES'] }.merge helper_query }
+
+    initialize_with { attributes }
+  end
+
+  factory :bad_ses, class:Hash do
+    body "{\"success\":false,\"errors\":{\"system\":\"Not logged in\"},\"time\":1363655473}"
+    query { { :apitask => 'teacher-classes' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] }.merge query } 
+    initialize_with { attributes }
+  end
+
+  factory :no_task, class:Hash do
+    body "No apitask specified"
+    query { {} }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] } }
+    initialize_with { attributes }
+  end
+
+  factory :bad_task, class:Hash do
+    body "Invalid apitask"
+    query { { :apitask => 'badtask' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'] }.merge query }
+    initialize_with { attributes }
+  end
+
+  factory :gradebook, class:Hash do
+    body "{\"clid\":\"101\",\"created\":1361653042,\"folder\":3,\"syr\":\"2013-2014\",\"gp\":1,\"gscale\":9,\"weighted\":0,\"showper\":1,\"stusort\":1,\"assnsort\":1,\"round\":1,\"stuview\":1,\"stumail\":0,\"gradelevel\":7,\"subject\":5,\"bb\":0,\"teachmail\":1,\"priteach\":\"1000008059883\",\"name\":\"Biology\",\"code\":null,\"stucount\":6,\"average\":69.3,\"missing\":0,\"failing\":1,\"registered\":0,\"acount\":2,\"stdset\":0,\"updated\":1363837018,\"cgs\":[{\"num\":1,\"low\":90,\"grade\":\"A\"},{\"num\":2,\"low\":80,\"grade\":\"B\"},{\"num\":3,\"low\":70,\"grade\":\"C\"},{\"num\":4,\"low\":60,\"grade\":\"D\"},{\"num\":5,\"low\":0,\"grade\":\"F\"}],\"cat\":[{\"num\":1,\"name\":\"Assignments\",\"weight\":null,\"dls\":0}],\"assignments\":[{\"clid\":\"101\",\"assnid\":2,\"created\":1363837018,\"creator\":\"1000008059883\",\"type\":1,\"cat\":1,\"cal\":1,\"bb\":1,\"turnin\":0,\"lastreplier\":0,\"lastreply\":0,\"replies\":0,\"attachments\":0,\"due\":20130320,\"points\":2,\"title\":\"Quiz\",\"gb\":1,\"showstu\":1,\"rubric\":0,\"itemid\":null,\"name\":\"Zachary Thompson\",\"usr\":\"zgthompson\",\"pic\":0},{\"clid\":\"101\",\"assnid\":1,\"created\":1362534970,\"creator\":\"1000008059883\",\"type\":1,\"cat\":1,\"cal\":1,\"bb\":1,\"turnin\":0,\"lastreplier\":0,\"lastreply\":0,\"replies\":0,\"attachments\":0,\"due\":20130305,\"points\":10,\"title\":\"Pop Quiz\",\"gb\":1,\"showstu\":1,\"rubric\":0,\"itemid\":null,\"name\":\"Zachary Thompson\",\"usr\":\"zgthompson\",\"pic\":0}],\"students\":[{\"stuid\":95956,\"num\":1,\"first\":\"George\",\"last\":\"Washington\",\"grade\":\"F\",\"percent\":17,\"missing\":0,\"acount\":2,\"status\":3},{\"stuid\":17406,\"num\":2,\"first\":\"John\",\"last\":\"Adams\",\"grade\":\"B\",\"percent\":83,\"missing\":0,\"acount\":2,\"status\":3},{\"stuid\":12345,\"num\":3,\"first\":\"Bob\",\"last\":\"Barker\",\"grade\":\"B\",\"percent\":83,\"missing\":0,\"acount\":2,\"status\":3},{\"stuid\":13371,\"num\":4,\"first\":\"Mary\",\"last\":\"Popper\",\"grade\":\"B\",\"percent\":83,\"missing\":0,\"acount\":2,\"status\":3},{\"stuid\":12567,\"num\":5,\"first\":\"Mark\",\"last\":\"Zuck\",\"grade\":\"C\",\"percent\":75,\"missing\":0,\"acount\":2,\"status\":3},{\"stuid\":44245,\"num\":6,\"first\":\"Frank\",\"last\":\"Cull\",\"grade\":\"C\",\"percent\":75,\"missing\":0,\"acount\":2,\"status\":3}],\"scores\":[{\"assnid\":1,\"stuid\":12345,\"score\":8},{\"assnid\":1,\"stuid\":12567,\"score\":8},{\"assnid\":1,\"stuid\":13371,\"score\":8},{\"assnid\":1,\"stuid\":17406,\"score\":8},{\"assnid\":1,\"stuid\":44245,\"score\":8},{\"assnid\":1,\"stuid\":95956,\"score\":1},{\"assnid\":2,\"stuid\":12345,\"score\":2},{\"assnid\":2,\"stuid\":12567,\"score\":1},{\"assnid\":2,\"stuid\":13371,\"score\":2},{\"assnid\":2,\"stuid\":17406,\"score\":2},{\"assnid\":2,\"stuid\":44245,\"score\":1},{\"assnid\":2,\"stuid\":95956,\"score\":1}],\"success\":true,\"time\":1363840611}"
+    json { JSON(body) }
+    assignments { json['assignments'] }
+    public_query { { :clid => '101' } }
+    helper_query { { :apitask => 'gradebook', :clid => '101' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'], :ses => ENV['ENG_SES'] }.merge helper_query }
+    initialize_with { attributes }
+  end
+
+  factory :bad_class, class:Hash do
+    body "{\"success\":false,\"errors\":{\"system\":\"You are not authorized to view this class\"},\"time\":1363843636}"
+    query { { :apitask => 'gradebook', :clid => '123456' } }
+    payload { { :api => 'json', :apikey => ENV['ENG_API'], :ses => ENV['ENG_SES'] }.merge query }
+    initialize_with { attributes }
+  end
+
+  factory :delete, class:Hash do
+    query { { :apitask => 'assignment-edit', :delete => '1',
+      :clid => '101', :assnid => '1' } }
+
+    initialize_with { attributes }
+  end
+
+end
+    

data/spec/integration_spec.rb

@@ -0,0 +1,22 @@
+require_relative 'spec_helper'
+
+describe Engrade do
+
+  it "should allow me to delete all my assignments" do
+    Engrade.set_apikey ENV['ENG_API']
+
+    VCR.use_cassette('login') { Engrade.login ENV['ENG_USER'], ENV['ENG_PASS'] }
+
+    VCR.use_cassette('classes') { @classes = Engrade.classes }
+
+    VCR.use_cassette('assignments') { @assignments = Engrade.assignments @classes }
+
+    VCR.use_cassette('delete') { Engrade.delete @assignments }
+
+    VCR.use_cassette('result') { @result = Engrade.assignments @classes }
+
+    @result.should be_empty
+  end
+
+end
+    

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'simplecov'
+SimpleCov.start
+
+#we need the actual library file
+require_relative '../lib/engrade'
+require_relative '../config/environment'
+require 'rspec'
+require 'factory_girl'
+require 'webmock/rspec'
+require 'vcr'
+
+FactoryGirl.find_definitions
+
+#RSpec config
+RSpec.configure do |spec|
+  spec.color_enabled = true
+  spec.tty = true
+  spec.include FactoryGirl::Syntax::Methods
+end
+
+#VCR config
+VCR.configure do |c|
+  c.default_cassette_options = { :serialize_with => :json, :preserve_exact_body_bytes => true }
+  c.cassette_library_dir = 'spec/fixtures/engrade_cassettes'
+  c.hook_into :webmock
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: engrade
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Zachary Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basic ruby wrapper for the Engrade API
+email:
+- zgthompson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/environment.rb.template
+- engrade.gemspec
+- lib/engrade.rb
+- lib/engrade/browser.rb
+- lib/engrade/exceptions.rb
+- lib/engrade/return_types.rb
+- lib/engrade/version.rb
+- spec/engrade_spec.rb
+- spec/factories/assignment_factory.rb
+- spec/factories/classroom_factory.rb
+- spec/factories/response_factory.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -813889549
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -813889549
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Utilize the Engrade API easily through Ruby
+test_files:
+- spec/engrade_spec.rb
+- spec/factories/assignment_factory.rb
+- spec/factories/classroom_factory.rb
+- spec/factories/response_factory.rb
+- spec/integration_spec.rb
+- spec/spec_helper.rb