engrade 1.0.0 → 1.0.1

data/README.md

@@ -1,25 +1,41 @@
-# Engrade::Ruby
+# engrade
 
-TODO: Write a gem description
+Ruby wrapper for the Engrade API
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```
+gem install 'engrade'
+```
 
-    gem 'engrade-ruby'
+## Usage
 
-And then execute:
+```ruby
+require 'engrade'
 
-    $ bundle
+# Getting started
 
-Or install it yourself as:
+Engrade.set_apikey('123456789')
+Engrade.login('username', 'password')
 
-    $ gem install engrade-ruby
+# Grabbing classes
 
-## Usage
+classes = Engrade.classes
+classes = Engrade.classes("Sem1")
+
+# Getting assignments from classes
+
+assignments = Engrade.assignments(classes)
 
-TODO: Write usage instructions here
+# Deleting assignments
 
+Engrade.delete(assignments)
+
+# Posting directly to Engrade
+# (make sure to set apikey and login first)
+
+Engrade.post(:apitask => 'assignment', :clid => '101', :assnid => '1')
+```
 ## Contributing
 
 1. Fork it
@@ -27,3 +43,7 @@ TODO: Write usage instructions here
 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
+
+## Contact
+Comments? Concerns? Want additional features?
+Contact me by email at zgthompson@gmail.com.

data/engrade.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = "https://github.com/zgthompson/engrade"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/engrade.rb

@@ -10,7 +10,7 @@ module Engrade
   ###########################
   # VARIABLES AND CONSTANTS #
   ###########################
-  #
+  
   @default_params = { :api => 'json' }
   @browser = Engrade::Browser.new
 
@@ -42,7 +42,7 @@ module Engrade
   # CORE FUNCTIONALITY #
   ######################
   
-  # .post takes merges the default_params with query, a hash of input fields,
+  # .post 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'})

data/lib/engrade/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engrade
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -198,7 +198,7 @@ files:
 - spec/factories/response_factory.rb
 - spec/integration_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/zgthompson/engrade
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -212,7 +212,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -813889549
+      hash: -562363953
 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: -813889549
+      hash: -562363953
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25