groupr 0.2.2 → 0.2.4

data/README.rdoc

@@ -6,20 +6,26 @@ Groupr provides an interface to the University of Washington Groups Service, whi
 
 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 <tt>group_exist?</tt> method to verify that a group exists.
 
+General group service documentation: https://wiki.cac.washington.edu/x/hgVS
+
+Groups API Documentation: https://wiki.cac.washington.edu/x/ESBy
+
 == 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
+* Delete a group via Groupr#delete_group
+* List group members via Groupr#view_membership
 * 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
+* A static UW-assigned DNS hostname, such as hiigara.cac.washington.edu [http://www.washington.edu/computing/network/addresses.html]
+* An X509 certificate signed by the UW Certificate Authority (UW CA): [https://iam-tools.u.washington.edu/cs/]
+* A copy of the UW CA root [https://www.washington.edu/itconnect/security/ca/uwca.crt]
 * Permissions assigned to a stem that it is working in.
 
 === Note on Permissions
@@ -27,21 +33,23 @@ Groupr is designed to work with a very specific application API, and is likely n
 * 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'
+* The host in question must have subgroup create or administration permissions 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
+	<code>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")</tt>
+	testr.cert = "path to certificate file" 
+	testr.group_exists?("u_nikky_awesome") 
+	testr.create_group("u_nikky_yeast-lords")</code>
 
 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"
+	<code>testr.ua_ca_file = "path to uwca root certificate"</code>
+
+In addition to getting all of the information from the HTTP request via Groupr#request, you can also view the return status message via Groupr#status.
 
 == Version History
 
@@ -68,6 +76,7 @@ Initial public release; undocumented.
 
 * Continue to expand current available options
 * Additional error handling checks
+* 
 
 == Copyright
 

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.4

data/groupr.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "groupr"
-  s.version = "0.2.2"
+  s.version = "0.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nikky Southerland"]
-  s.date = "2012-12-10"
+  s.date = "2012-12-11"
   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

@@ -37,35 +37,35 @@ class Groupr
     members
   end
 
-  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Effective+Members
-  def get_effective_membership
-  end
+  # # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Effective+Members
+  # def get_effective_membership
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Update+Members
-  def update_membership
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Update+Members
+  # def update_membership
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Delete+Members
-  def delete_membership
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Delete+Members
+  # def delete_membership
+  # end
 
-  ## Member-related methods
+  # ## Member-related methods
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Member
-  def get_member
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Member
+  # def get_member
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Effective+Member
-  def get_effective_member
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Effective+Member
+  # def get_effective_member
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Add+Member
-  def add_member
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Add+Member
+  # def add_member
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Delete+Member
-  def delete_member
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Delete+Member
+  # def delete_member
+  # end
 
 
   ## Group-related methods. View, create, update, delete.
@@ -128,15 +128,15 @@ class Groupr
     end
   end
 
-  ## Search
+  # ## Search
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Search
-  def search
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Search
+  # def search
+  # end
 
-  # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+History
-  def get_history
-  end
+  # # http://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+History
+  # def get_history
+  # end
 
 
   private
@@ -188,25 +188,12 @@ class Groupr
     puts "Body is: #{@response.body}"
     @response.body
   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
+
+  # Creates some basic methods to pull common classes out
+  %w(contact title description name regid).each do |element|
+    define_method("get_#{element}") do
+      @doc.xpath("//span[@class=\"#{element}\"]").text
+    end
   end
 
 end

data/spec/groupr_spec.rb

@@ -77,6 +77,9 @@ describe "Groupr" do
         @group.status.should eq "No authorization"
       end
     end
+    context "#update_group" do
+      it "Should let you edit the attributes of an already existing group"
+    end
   end
   context "member operations" do
 
@@ -84,18 +87,20 @@ describe "Groupr" do
       before do
         @group.should_receive(:make_get_request).and_return(File.open("spec/sample_responses/get_membership.html"))
       end
-      it "Gets the members of a group" do
+      it "Should get the members of a group" do
         @group.get_membership("u_nikky_awesome").should eq ["blogs", "blogsdev", "hiigara.cac.washington.edu", "nikky", "nikky.cac.washington.edu", "solanum.cac.washington.edu", "sqltest", "u_nikky_git", "webtest"]
       end
 
     end
-
-    context "#add_member" do
-      it "Adds a member to a group"
+    context "#get_effective_members" do
+      it "Should list the effective membership of a group"
+    end
+    context "#add_members" do
+      it "Should add member(s) to a group"
     end
 
-    context "#remove_member" do
-      it "Removes a member from a group"
+    context "#delete_members" do
+      it "Removes member(s) from a group"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupr
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-10 00:00:00.000000000 Z
+date: 2012-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -126,9 +126,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 379539324252946890
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: