groupr 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+	- 1.9.3
+	- rbx-19mode
+	- jruby-19mode
+	- ree

data/README.rdoc

@@ -1,3 +1,5 @@
+{<img src="https://travis-ci.org/allynfolksjr/groupr.png" />}[https://travis-ci.org/allynfolksjr/groupr]
+
 = groupr
 
 Description goes here.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/groupr.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "groupr"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nikky Southerland"]
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.rdoc",
@@ -27,6 +28,7 @@ Gem::Specification.new do |s|
     "groupr.gemspec",
     "lib/groupr.rb",
     "spec/groupr_spec.rb",
+    "spec/sample_responses/view_group.html",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/allynfolksjr/groupr"

data/lib/groupr.rb

@@ -1,76 +1,186 @@
 require 'net/http'
 require 'nokogiri'
 class Groupr
-	attr_accessor :api_url, :certificate, :key, :uw_ca_file
-	def initialize
-		@api_url = "https://iam-ws.u.washington.edu:7443/group_sws/v2"
-		@uw_ca_file = "#{ENV['HOME']}/uwca.crt"
-	end
-	def make_get_request
-		options = {
-			use_ssl: true,
-			cert: OpenSSL::X509::Certificate.new(@certificate),
-			key: OpenSSL::PKey::RSA.new(@key),
-			ca_file: @uw_ca_file,
-			verify_mode: OpenSSL::SSL::VERIFY_PEER
-		}
-		Net::HTTP.start(@uri.host, @uri.port, options) do |http|
-			request = Net::HTTP::Get.new(@uri.request_uri)
-			@response = http.request(request)
-		end
-		@response.body
-	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
-	def get_response_code
-		@response.code.to_i
-	end
-	def group_exists?(group)
-		@uri = URI.parse("#{@api_url}/group/#{group}")
-		make_get_request
-		if get_response_code == 200
-			true
-		else
-			false
-		end
-	end
-	
-	def view_group(group)
-		@uri = URI.parse("#{@api_url}/group/#{group}")
-		body = make_get_request
-		@doc = Nokogiri::HTML(body)
-		{
-			title: get_title,
-			description: get_description,
-			name: get_name,
-			regid: get_regid,
-			contact: get_contact
-		}
-	end
-
-	def get_contact
-		@doc.xpath('//span[@class="contact"]').text
-	end
-
-	def get_title
-		@doc.xpath('//span[@class="title"]').text
-	end
-	def get_description
-		@doc.xpath('//span[@class="description"]').text
-	end
-	def get_name
-		@doc.xpath('//span[@class="name"]').text
-	end
-	def get_regid
-		@doc.xpath('//span[@class="regid"]').text
-	end
-
-	# def other thing to use
-	# http.ssl_timeout
-	# It throws TimeoutError exceptions for timeouts
-	# http.cert_store to for.... the CA?
-	# or maybe http.ca_file
-end
+  attr_accessor :api_url, :certificate, :key, :uw_ca_file
+  attr_reader :request
+  def initialize
+    @api_url = "https://iam-ws.u.washington.edu:7443/group_sws/v2"
+    @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
+  def get_response_code
+    @response.code.to_i
+  end
+  def group_exists?(group)
+    @uri = URI.parse("#{@api_url}/group/#{group}")
+    make_get_request
+    if get_response_code == 200
+      true
+    else
+      false
+    end
+  end
+
+  ## Membership-related methods: get, get effective, update, delete
+
+
+  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Members
+  def get_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+Delete+Members
+  def delete_membership
+  end
+
+  ## 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+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+Delete+Member
+  def delete_member
+  end
+
+
+  ## Group-related methods. View, create, update, delete.
+
+  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Get+Group
+  def view_group(group)
+    @uri = URI.parse("#{@api_url}/group/#{group}")
+    body = make_get_request
+    @doc = Nokogiri::HTML(body)
+    {
+      title: get_title,
+      description: get_description,
+      name: get_name,
+      regid: get_regid,
+      contact: get_contact
+    }
+  end
+
+
+
+  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Create+Group
+  def create_group(group,description=nil)
+  	@group = group
+  	description.nil? ? @description = group : @description = description 
+    @uri = URI.parse("#{@api_url}/group/#{group}")
+    make_put_request
+    get_response_code == 200 ? true : false
+  end
+
+  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Update+Group
+  def update_group
+  end
+
+  # https://wiki.cac.washington.edu/display/infra/Groups+WebService+Delete+Group
+  def delete_group
+  end
+
+  ## Search
+
+  # 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
+
+
+  private
+  def make_get_request
+    options = {
+      use_ssl: true,
+      cert: OpenSSL::X509::Certificate.new(@certificate),
+      key: OpenSSL::PKey::RSA.new(@key),
+      ca_file: @uw_ca_file,
+      verify_mode: OpenSSL::SSL::VERIFY_PEER
+    }
+    Net::HTTP.start(@uri.host, @uri.port, options) do |http|
+      request = Net::HTTP::Get.new(@uri.request_uri)
+      @response = http.request(request)
+    end
+    @response.body
+  end
+
+  def make_put_request
+    options = {
+      use_ssl: true,
+      cert: OpenSSL::X509::Certificate.new(@certificate),
+      key: OpenSSL::PKey::RSA.new(@key),
+      ca_file: @uw_ca_file,
+      verify_mode: OpenSSL::SSL::VERIFY_PEER
+    }
+    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>}
+      @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
+
+  def get_contact
+    @doc.xpath('//span[@class="contact"]').text
+  end
+
+  def get_title
+    @doc.xpath('//span[@class="title"]').text
+  end
+
+  def get_description
+    @doc.xpath('//span[@class="description"]').text
+  end
+
+  def get_name
+    @doc.xpath('//span[@class="name"]').text
+  end
+
+  def get_regid
+    @doc.xpath('//span[@class="regid"]').text
+  end
+
+end

data/spec/groupr_spec.rb

@@ -2,65 +2,77 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Groupr" do
 
-	before do
-		@group = Groupr.new
-		@group.certificate = File.read("#{ENV['HOME']}/nikky_cac_washington_edu.cert")
-		@group.key = File.read("#{ENV['HOME']}/nikky_cac_washington_edu.key")
-	end
+  before do
+    @group = Groupr.new
+  end
 
-	it "Checks for network connectivity"
-	it "Should allow you to specify a custom Service API" do
-		@group.respond_to?(:api_url).should eq true
-	end
-	it "Should allow you to specify your certificate" do
-		@group.respond_to?(:certificate).should eq true
-	end
-	it "Should Allow you to specify your key" do
-		@group.respond_to?(:key).should eq true
-	end
+  it "Checks for network connectivity"
+  it "Should allow you to specify a custom Service API" do
+    @group.respond_to?(:api_url).should eq true
+  end
+  it "Should allow you to specify your X509 certificate" do
+    @group.respond_to?(:certificate).should eq true
+  end
+  it "Should Allow you to specify your RSA key" do
+    @group.respond_to?(:key).should eq true
+  end
+  context "group operations" do
+    context "#group_exists?" do
+      it "Should tell you that the uw_employees group exists" do
+        @group.should_receive(:make_get_request).and_return(nil)
+        @group.should_receive(:get_response_code).and_return(200)
+        @group.group_exists?("u_nikky_git").should be_true
+      end
+      it "Should tell you that the a_team group does not exist" do
+        @group.should_receive(:make_get_request).and_return(nil)
+        @group.should_receive(:get_response_code).and_return(404)
+        @group.group_exists?("a_team").should be_false
+      end
+    end
 
-	context "#group_exists?" do
-		it "Should tell you that the uw_employees group exists" do
-			@group.should_receive(:make_get_request).and_return(nil)
-			@group.should_receive(:get_response_code).and_return(200)
-			@group.group_exists?("u_nikky_git").should be_true
-		end
-		it "Should tell you that the a_team group does not exist" do
-			@group.should_receive(:make_get_request).and_return(nil)
-			@group.should_receive(:get_response_code).and_return(404)
-			@group.group_exists?("a_team").should be_false
-		end
-	end
+    context "#view_group" do
+      before do
+        @group.should_receive(:make_get_request).and_return(File.open('spec/sample_responses/view_group.html'))
+        @results = @group.view_group("u_nikky_git")
+      end
+      it "Should tell you the group name" do
+        @results[:name].should eq "u_nikky_git"
+      end
+      it "Should tell you the group description" do
+        @results[:description].should_not == ""
+      end
+      it "Should tell you the group contact" do
+        @results[:contact].should eq "nikky"
+      end
+      it "Should tell you the group title" do
+        @results[:title].should eq "nikky git"
+      end
+    end
+    context "#create_group" do
+      before do
+        @group.should_receive(:make_put_request).and_return(nil)
+      end
+      it "Should create a new group" do
+      	@group.should_receive(:get_response_code).and_return(200)
+        @group.create_group("u_test_hi").should eq true
+      end
+      it "Should fail to create a new group if the response code is non-200" do
+      	@group.should_receive(:get_response_code).and_return(419)
+      	@group.create_group("u_test_hi").should eq false
+      end
 
-	context "#view_group" do
-		before do
-			@group.should_receive(:make_get_request).and_return(File.open('view_group.html'))
-			@results = @group.view_group("u_nikky_git")
-		end
-		it "Should tell you the group name" do
-			@results[:name].should eq "u_nikky_git"
-		end
-		it "Should tell you the group description" do
-			@results[:description].should_not == ""
-		end
-		it "Should tell you the group contact" do
-			@results[:contact].should eq "nikky"
-		end
-		it "Should tell you the group title" do
-			@results[:title].should eq "nikky git"
-		end
-	end
+    end
 
+    context "#get_members" do
+      it "Gets the members of a group"
+    end
 
-	context "#get_members" do
-		it "Gets the members of a group"
-	end
+    context "#add_member" do
+      it "Adds a member to a group"
+    end
 
-	context "#add_member" do
-		it "Adds a member to a group"
-	end
-
-	context "#remove_member" do
-		it "Removes a member from a group"
-	end
+    context "#remove_member" do
+      it "Removes a member from a group"
+    end
+  end
 end

data/spec/sample_responses/view_group.html

@@ -0,0 +1,87 @@
+<!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="text/html; charset=US-ASCII"></head>
+<body>
+
+   
+
+
+<div class="group" version="2">
+
+ Regid: <span class="regid">ddd677bfea054b2191fd7bcdf4d715e4</span>
+ <br><span class="names">
+ Name: <span class="name">u_nikky_git</span>
+ </span>
+ <br>
+ Title: <span class="title">nikky git</span>
+ <br>
+ Description: <span class="description">List to restrict access to my "public" git repository to CAC and other campus support staff as needed.</span>
+ <br>
+
+ Group contact: <span class="contact">nikky</span>
+ <br>
+
+ Created: <span class="createtime">1292452356669</span>
+ <br>
+ Modified: <span class="modifytime">1292452357055</span>
+ <br>
+ Membership modified: <span class="membermodifytime">1301805036473</span>
+ <br>
+ Authn factor: <span class="authnfactor">1</span>
+ <br>
+ Classification: <span class="classification">u</span>
+ <br>
+ Membership dependency group: <span class="dependson"></span>
+
+  
+
+ Email Enabled: <span class="emailenabled">disabled</span>
+ <br>
+ 
+   Published email address: <span class="publishemail"></span>
+ <br>
+
+  Report to owner:
+     <span class="reporttoowner">no</span>
+    <br>
+ 
+  Allowed senders: <ul class="authorigs">
+<li class="authorig" type="none">dc=none</li>
+     </ul>
+
+  
+
+    
+
+
+ 
+  Administrators:
+  <ul class="admins">
+<li class="admin" type="uwnetid">nikky</li>
+       </ul>
+  Updaters:
+  <ul class="updaters"></ul>
+  Creators:
+  <ul class="creators"></ul>
+  Readers:
+  <ul class="readers">
+<li class="reader" type="none">dc=all</li>
+       </ul>
+
+  Optins:
+  <ul class="optins"></ul>
+  Optouts:
+  <ul class="optouts"></ul>
+<br>
+
+ Membership: <a rel="members" href="/group_sws/v2/group/ddd677bfea054b2191fd7bcdf4d715e4/member">Membership</a>
+
+</div>
+
+<div class="status"></div>
+
+
+
+
+</body>
+</html>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: groupr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -117,6 +117,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.rdoc
@@ -125,6 +126,7 @@ files:
 - groupr.gemspec
 - lib/groupr.rb
 - spec/groupr_spec.rb
+- spec/sample_responses/view_group.html
 - spec/spec_helper.rb
 homepage: http://github.com/allynfolksjr/groupr
 licenses:
@@ -141,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2323866880024639544
+      hash: 4214034756816010912
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: