engrade 1.0.1 → 1.1.1

data/README.md

@@ -21,15 +21,18 @@ Engrade.login('username', 'password')
 # Grabbing classes
 
 classes = Engrade.classes
-classes = Engrade.classes("Sem1")
+classes = Engrade.classes(:only => "Sem1")
+classes = Engrade.classes(:except => "Biology")
 
 # Getting assignments from classes
 
 assignments = Engrade.assignments(classes)
+assignments = Engrade.assignments(classes, :only => "Final")
+assignments = Engrade.assignments(classes, :except => "Quiz")
 
 # Deleting assignments
 
-Engrade.delete(assignments)
+Engrade.delete!(assignments)
 
 # Posting directly to Engrade
 # (make sure to set apikey and login first)

data/lib/engrade.rb

@@ -73,35 +73,30 @@ module Engrade
 
   
   # .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) }
+  # classes). when no argument is given, all classes are returned. the classes
+  # can be filtered by calling with the :only or :except option.
+  def self.classes(options={})
+    filter teacher_classes, options
   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
+  # assignments can be filtered by calling with the additional :only or :except
+  # option.
+  def self.assignments(classes, options={})
+    filter all_assignments(classes), options
   end
 
 
-  # .delete takes in an array of Assignment object, or a single Assignment
+
+  # .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)
+  def self.delete!(assignments)
     assignments = array(assignments)
     assignments.each do |assn|
       @browser.remove_comments assn.clid, assn.assnid
@@ -113,8 +108,26 @@ module Engrade
   # HELPER METHODS #
   ##################
 
+  def self.filter(array=[], options={})
+    var = :name if array.first.instance_of? Classroom
+    var = :title if array.first.instance_of? Assignment
+    array.select! { |item| item.send(var).match options[:only]} if options[:only]
+    array.reject! { |item| item.send(var).match options[:except]} if options[:except]
+    array
+  end
+
+  def self.all_assignments(classes)
+    assignments = []
+    clid_array(classes).each do |clid|
+      (Engrade.gradebook :clid => clid).
+        map { |assn| assignments << Assignment.new(assn) }
+    end
+    assignments
+  end
+
   def self.teacher_classes(query={})
-    JSON(post :apitask => 'teacher-classes')['classes']
+    class_hash = JSON(post :apitask => 'teacher-classes')['classes']
+    class_hash.map { |cl| Classroom.new(cl) }
   end
 
 

data/lib/engrade/version.rb

@@ -1,3 +1,3 @@
 module Engrade
-    VERSION = "1.0.1"
+    VERSION = "1.1.1"
 end

data/spec/engrade_spec.rb

@@ -10,350 +10,300 @@ describe Engrade 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
+  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
 
-    describe ".set_apikey" do
+  end
 
-      it "should set :apikey in default_params" do
-        Engrade.set_apikey 'test'
-        Engrade.default_params[:apikey].should eql 'test'
-      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
 
-    describe ".set_ses" do
+  end
 
-      it "should set :ses in default_params" do
-        Engrade.set_ses 'test'
-        Engrade.default_params[:ses].should eql 'test'
-      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
 
-    describe ".reset!" do
+  end
 
-      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
+  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
 
-    describe ".post" do
+  end
 
-      before :each do
-        Engrade.set_apikey ENV['ENG_API']
-      end
+  describe ".post" do
 
-      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
+    before :each do
+      Engrade.set_apikey ENV['ENG_API']
+    end
 
-      context "with valid call" do
+    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
 
-        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
+    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
 
-      context "when not logged in" do
+    end
 
-        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
+    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
 
-      context "with bad apikey" do
+    end
 
-        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
+    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
 
-      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
+    end
 
-      context "with invalid apitask specified" do
+    context "with no 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
-      
+      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
 
-    describe ".login" do
+    context "with invalid apitask specified" do
 
-      before :each do
-        Engrade.browser.stub :login
+      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
 
-      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
+  end
 
-      context "with valid credentials" do
+  describe ".login" do
 
-        before :each do
-          @response = build(:login)
-          Engrade.stub(:post).and_return @response[:body]
-        end
+    before :each do
+      Engrade.browser.stub :login
+    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 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
 
-        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
+    context "with valid credentials" do
 
+      before :each do
+        @response = build(:login)
+        Engrade.stub(:post).and_return @response[:body]
       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
-
+      it "should return the session id" do
+        Engrade.login(ENV['ENG_USER'], ENV['ENG_PASS']).
+          should eql @response[:json]['values']['ses']
       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
-
+      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
 
-    describe ".classes" do
+    context "with invalid username" do
 
-      before :each do
-        @classes = build(:teacher_classes)[:classes]
-        Engrade.stub(:teacher_classes).and_return @classes
+      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
 
-      it "should call .teacher_classes with the proper query" do
-        Engrade.should_receive(:teacher_classes).with(no_args).
-          and_return @classes
-        Engrade.classes
+    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
 
-      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 ".classes" do
 
+    before :each do
+      Engrade.stub(:post).and_return build(:teacher_classes)[:body]
     end
 
-    describe ".assignments" do
+    describe "return value" do
 
-      before :each do
-        @response = build :gradebook
-        Engrade.stub(:gradebook).and_return @response[:assignments]
+      it "should be an Array" do
+        Engrade.classes.should be_an_instance_of Array
       end
 
-      it "should take a class id as input" do
-        expect { Engrade.assignments((build :classroom).clid) }.to_not raise_error
+      it "should contain Classroom objects" do
+        Engrade.classes.first.should be_an_instance_of Engrade::Classroom
       end
 
-      it "should take a classroom object as input" do
-        expect { Engrade.assignments(build :classroom) }.to_not raise_error
+      it "should only include classes that match the :only parameter" do
+        Engrade.classes(:only => "Sem1").each do |cl|
+          cl.name.should match "Sem1"
+        end
       end
 
-      it "should take an array of classroom objects as input" do
-        expect { Engrade.assignments [build(:classroom), build(:classroom)] }.
-          to_not raise_error
+      it "should not include classes that match the :except paramter" do
+        Engrade.classes(:except => "Sem1").each do |cl|
+          cl.name.should_not match "Sem1"
+        end
       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
+    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
+  end
 
+  describe ".assignments" do
 
-      it "should call .gradebook with the appropriate query" do
-        Engrade.should_receive(:gradebook).with @response[:public_query]
-        Engrade.assignments build(:classroom)
-      end
+    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
 
-      describe "return value" do
+    it "should take a classroom object as input" do
+      expect { Engrade.assignments(build :classroom) }.to_not raise_error
+    end
 
-        it "should be an Array" do
-          Engrade.assignments(build :classroom).should be_an_instance_of Array
-        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 contain Assignment objects" do
-          Engrade.assignments(build :classroom).first.
-            should be_an_instance_of Engrade::Assignment
-        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 contain assigments from all input classes" do
-          Engrade.assignments(build :classroom).size.should be < Engrade.assignments([build(:classroom), build(:classroom)]).size
-        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
 
-      end
 
+    it "should call .gradebook with the appropriate query" do
+      Engrade.should_receive(:gradebook).with @response[:public_query]
+      Engrade.assignments build(:classroom)
     end
 
-    describe ".delete" do
+
+    describe "return value" do
 
       before :each do
-        Engrade.set_ses ENV['ENG_SES']
-        Engrade.stub :post
-        Engrade.browser.stub :remove_comments
+        @class = build :classroom
       end
 
-      it "should accept an array of Assignments as input" do
-        assignments = [build(:assignment), build(:assignment)]
-        expect { Engrade.delete assignments }.to_not raise_error
+      it "should be an Array" do
+        Engrade.assignments(@class).should be_an_instance_of Array
       end
 
-      it "should accept a single Assignment as input" do
-        assignment = build :assignment
-        expect { Engrade.delete assignment }.to_not raise_error
+      it "should contain Assignment objects" do
+        Engrade.assignments(@class).first.
+          should be_an_instance_of Engrade::Assignment
       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
+      it "should contain assigments from all input classes" do
+        Engrade.assignments(@class).size.
+          should be < Engrade.assignments([@class, @class]).size
+      end
+      
+      it "should only include assignments that match the :only parameter" do
+        Engrade.assignments(@class, :only => "Pop Quiz").each do |assn|
+          assn.title.should match "Pop Quiz"
+        end
       end
 
-      it "should call .post with proper query" do
-        Engrade.should_receive(:post).with build(:delete)[:query]
-        Engrade.delete [build(:assignment)]
+      it "should not include assignments that match the :except paramter" do
+        Engrade.assignments(@class, :except => "Pop Quiz").each do |assn|
+          assn.title.should_not match "Pop Quiz"
+        end
       end
-      
+
     end
 
   end
 
-  describe "helper method" do
-
-
-    describe ".teacher_classes" do
+  describe ".delete!" do
 
     before :each do
-      Engrade.set_apikey ENV['ENG_API']
       Engrade.set_ses ENV['ENG_SES']
-      @response = build :teacher_classes
-      Engrade.stub :classes
+      Engrade.stub :post
+      Engrade.browser.stub :remove_comments
     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
-
+    it "should accept an array of Assignments as input" do
+      assignments = [build(:assignment), build(:assignment)]
+      expect { Engrade.delete! assignments }.to_not raise_error
     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
+    it "should accept a single Assignment as input" do
+      assignment = build :assignment
+      expect { Engrade.delete! assignment }.to_not raise_error
+    end
 
-      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

data/spec/integration_spec.rb

@@ -11,7 +11,7 @@ describe Engrade do
 
     VCR.use_cassette('assignments') { @assignments = Engrade.assignments @classes }
 
-    VCR.use_cassette('delete') { Engrade.delete @assignments }
+    VCR.use_cassette('delete') { Engrade.delete! @assignments }
 
     VCR.use_cassette('result') { @result = Engrade.assignments @classes }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engrade
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -212,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -562363953
+      hash: -299844275
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -562363953
+      hash: -299844275
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25