groupr 0.2.0 → 0.2.1

data/README.rdoc

@@ -2,17 +2,67 @@
 
 = groupr
 
-Description goes here.
-
-== Contributing to groupr
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+Groupr provides an interface to the University of Washington Groups Service, which allows administrators to leverage a simple yet robust groups system for access control for applications campus-wide.
+
+Groupr strives to followly closely to the naming conventions and functions as outlined in the Groups Service documentation, but does expand certain functionality, notably adding the `group_exist?` method to verify that a group exists.
+
+== Features
+
+* Ability to check if a group exists via Groupr#group_exists?
+* Get title, description, name, regid, and contact of a group via Groupr#view_group
+* Create a group and optionally add a description via Groupr#create_group
+* Option to manually specify a different API url; useful if new or testing versions of the Groups Service API become available.
+
+== System Requirements
+
+Groupr is designed to work with a very specific application API, and is likely not useful to users not affiliated with the University of Washington. It is designed to work with a system that has:
+
+* A static UW-assigned DNS hostname, such as hiigara.cac.washington.edu
+* An X509 certificate signed by the UW Certificate Authority (UW CA)
+* A copy of the UW CA root
+* Permissions assigned to a stem that it is working in.
+
+=== Note on Permissions
+
+* This utilizes the hostname-based feature of the UW groups service. this hostname is the one assigned to you by the UW Network Operations center, and should be the same as the X509 certificate hostname as outlined above.
+* When working on a group that is already created, you must assign this hsotname to one of the permissions available to you. For instance, if working on the 'u_nikky_awesome' group, you must allow 'hiigara.cac.washington.edu' as an administrator if you want to give this host full access to that group.
+* When creating new groups, this host is automatically added as an administrator. You can remove this after creating the group, if desired.
+* The host in question must have <insert permissions here> in order to create new groups. For instance, if 'hiigara.cac.washington.edu' has subgroup permissions for the 'u_nikky' stem, it can create subgroups such as 'u_nikky_awesomeo'
+
+== Instructions
+
+Once the conditions as outlined in "system requirements" are met, this gem can be utilized. 
+
+`testr = Groupr.new
+testr.key = "path to key file"
+testr.cert = "path to certificate file"
+testr.group_exists?("u_nikky_awesome")
+testr.create_group("u_nikky_yeast-lords")`
+
+By default, it will look for a UWCA root file in ~/uwca.crt. You can manually change this by running:
+
+`testr.ua_ca_file = "path to uwca root certificate"`
+
+== Version History
+
+=== 0.2.1
+
+Initial documentation release
+
+=== 0.1.0
+
+Initial public release; undocumented.
+
+== Known Issues
+
+* Current error handling is sparse
+* Many features not implemented
+* Many optional features of current functions not implemented
+
+== To-do
+
+* Continue to expand current available options
+* Additional error handling checks
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/groupr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "groupr"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nikky Southerland"]
-  s.date = "2012-12-07"
+  s.date = "2012-12-10"
   s.description = "Gem used to interact with University of Washington Groups Service"
   s.email = "nikky@uw.edu"
   s.extra_rdoc_files = [

data/lib/groupr.rb

@@ -8,11 +8,7 @@ class Groupr
     @uw_ca_file = "#{ENV['HOME']}/uwca.crt"
   end
 
-  # This method returns nil if the http request doesn't return a 200. Maybe also support for not-authorized?
-  # def validate_response(response)
-  # 	nil if get_response_code != 200
-  # 	response.body if get_response_code == 200
-  # end
+  public
   def get_response_code
     @response.code.to_i
   end
@@ -87,6 +83,22 @@ class Groupr
   	@group = group
   	description.nil? ? @description = group : @description = description 
     @uri = URI.parse("#{@api_url}/group/#{group}")
+    @request_text = %Q{<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+      "http://www.w3.org/TR/xhtml11/DTD/xhtml11/dtd">
+    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+    <head>
+    <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
+    </head>
+    <body>
+        <div class="group">
+        <span class="description">#{@description}</span>
+          <ul class="names"><li class="name">#{@group}</li></ul>
+          <ul class="admins">
+              <li class="admin">nikky</li>
+          </ul>
+        </div>
+    </body>
+  </html>}
     make_put_request
     get_response_code == 200 ? true : false
   end
@@ -111,6 +123,7 @@ class Groupr
 
 
   private
+  # This makes a get request against the groups service, useful for getting information
   def make_get_request
     options = {
       use_ssl: true,
@@ -125,7 +138,7 @@ class Groupr
     end
     @response.body
   end
-
+  # This makes a put request against the groups service, useful for pushing information
   def make_put_request
     options = {
       use_ssl: true,
@@ -136,49 +149,30 @@ class Groupr
     }
     Net::HTTP.start(@uri.host, @uri.port, options) do |http|
       request = Net::HTTP::Put.new(@uri.request_uri)
-      request.body = %Q{<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-  		"http://www.w3.org/TR/xhtml11/DTD/xhtml11/dtd">
-		<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-		<head>
- 		<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
-		</head>
-		<body>
-  			<div class="group">
-   			<span class="description">#{@description}</span>
-    			<ul class="names"><li class="name">#{@group}</li></ul>
-    			<ul class="admins">
-        			<li class="admin">nikky</li>
-    			</ul>
-  			</div>
-		</body>
-	</html>}
+      request.body = @request_text
       @response = http.request(request)
     end
     puts "Response is: #{get_response_code}"
     puts "Body is: #{@response.body}"
     @response.body
   end
-
-  def get_response_code
-    @response.code.to_i
-  end
-
+  # Returns the contact information of a group
   def get_contact
     @doc.xpath('//span[@class="contact"]').text
   end
-
+  # Returns the group title
   def get_title
     @doc.xpath('//span[@class="title"]').text
   end
-
+  # Returns the group description
   def get_description
     @doc.xpath('//span[@class="description"]').text
   end
-
+  # Returns the group name
   def get_name
     @doc.xpath('//span[@class="name"]').text
   end
-
+  # Returns the unique group regid
   def get_regid
     @doc.xpath('//span[@class="regid"]').text
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupr
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-07 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -143,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4214034756816010912
+      hash: -3689606592973473629
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: