rgroups 0.1.0 → 0.2.0

data/README.rdoc

@@ -2,6 +2,31 @@
 
 Ruby API for accessing/updating Google Groups - based on Mechanize. This essentially just screen-scrapes Google Groups and automates clicking on things. It's not entirely efficient, but it sure beats having to script it yourself.
 
+== Usage
+Setup is easy!
+ require 'rgroups'
+ rg = RGroup.new
+ rg.login('username', 'password')
+
+Or, if you're using Google Apps for your Domain (GAFYD):
+ rg = RGroup.new('mydomain.com')
+ rg.login('username', 'password')
+
+Adding a user to a group:
+ rg.add_user('address@domain.com', 'group', :message => 'message to send to invitees')
+
+Adding a user directly (only for GAFYD accounts):
+ rg.add_user('address@mydomain.com', 'group', :mode => 'direct', :notify => true, :message => 'message to send to people', :delivery => 'digest')
+
+Modifying a user's delivery options:
+ rg.update_user('address@domain.com', 'group', 'set_delivery', :value => 'summary')
+
+Modifying a user's membership type:
+ rg.update_user('address@domain.com', 'group', 'set_member', :value => 'manager')
+
+== Notes
+This relies on the 'old style' Google Groups. Please ensure that your group is using the old style before reporting a bug. Support for the new style should come soon...
+ 
 == Contributing to rgroups
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/rgroups.rb

@@ -6,6 +6,10 @@ class RGroup
     @@DIRECT_ADD = '/manage_members_add'
     @@INVITE_ADD = '/members_invite'
 	@@GROUP_SETTINGS = '/manage_general'
+	@@ACCESS_SETTINGS = '/manage_access'
+	@@POST_SETTINGS = '/manage_post'
+	@@ADV_SETTINGS = '/manage_advanced'
+	@@SPAM_SETTINGS = '/manage_spam'
 	
     def initialize(*gafyd)
         @scraper = Mechanize.new
@@ -19,7 +23,8 @@ class RGroup
             @GAFYD = true
         end
     end
-
+	
+	# login to google apps
     def login(username, password)
         page = @scraper.get(@LOGIN_URL)
         f = page.forms[0]
@@ -28,6 +33,14 @@ class RGroup
         @scraper.submit(f, f.buttons.first)
     end
 	
+	# add a user
+	# email = email address to add
+	# group = group name
+	# :mode => direct (only for gafyd accounts)
+	# :notify => true/false to notify users they've been added (only for gafyd)
+	# :delivery => only for gafyd
+	# - none, email, summary, one
+	# :message => message to send to person when being added
 	def add_user(email, group, opts={})
 		if (opts[:mode] && opts[:mode].downcase == "direct")
 			raise "direct add mode is only available for gafyd accounts" unless @GAFYD
@@ -73,6 +86,13 @@ class RGroup
 		@scraper.submit(member_form, member_form.button_with(:name => 'Action.InitialAddMembers'))
 	end
     
+    # update a user
+	# email = email address to update
+	# group = group name
+	# action = set_member, set_email
+	# :value => depends on what you're doing. 
+	# - set_member: regular, manager, owner, unsubscribe, ban
+	# - set_email: none, email, summary, one
     def update_user(email, group, action, opts={})
         page = @scraper.get(@BASE_URL + group + @@MANAGE)
 		member_set = page.search('//table[@class="memlist"]//td')
@@ -120,9 +140,99 @@ class RGroup
 		
 	end
 	
+	# return a hash of group settings
+	def settings(group)
+		settings = {}
+		
+		page = @scraper.get(@BASE_URL + group + @@GROUP_SETTINGS)
+		settings['group_name'] = page.search('//div[@id="name_view"]').text.strip
+		settings['group_description'] = page.search('//div[@id="desc_view"]').text.strip
+		settings['group_website'] = page.search('//div[@id="info_url_view"]').text.strip
+		
+		
+		page = @scraper.get(@BASE_URL + group + @@ACCESS_SETTINGS)
+		form = page.form_with(:id => "GM_form")
+		if (@GAFYD)
+			settings['allow_external']  = form.checkbox_with(:name => 'param.allow_external_members').checked?
+		end
+		form.radiobuttons_with(:name => 'param.archive_view').each do |r|
+			settings['archive_view'] = r.value if r.checked?
+		end
+		form.radiobuttons_with(:name => 'param.members_view').each do |r|
+			settings['member_view'] = r.value if r.checked?
+		end
+		form.radiobuttons_with(:name => 'param.who_can_join').each do |r|
+			settings['can_join'] = r.value if r.checked?
+		end
+		settings['join_question'] = form.field_with(:name => 'param.join_question').value.strip
+		form.radiobuttons_with(:name => 'param.who_can_post').each do |r|
+			settings['who_can_post'] = "managers" if r.checked?  && r.value == 'm'
+			settings['who_can_post'] = "members" if r.checked?  && r.value == 's'
+			settings['who_can_post'] = "domain" if r.checked?  && r.value == 'd'
+			settings['who_can_post'] = "anyone" if r.checked?  && r.value == 'p'
+		end
+		settings['mod_non_members']  = form.checkbox_with(:name => 'param.mod_non_members').checked?
+		settings['web_posting']  = form.checkbox_with(:name => 'param.allow_web_posting').checked?
+		form.radiobuttons_with(:name => 'param.who_can_invite').each do |r|
+			settings['who_can_invite'] = r.value if r.checked?
+		end
+		form.radiobuttons_with(:name => 'param.msg_moderation').each do |r|
+			settings['msg_moderation'] = r.value if r.checked?
+		end
+		settings['mod_new_members']  = form.checkbox_with(:name => 'param.mod_new_members').checked?
+		
+		
+		page = @scraper.get(@BASE_URL + group + @@POST_SETTINGS)
+		form = page.form_with(:id => "GM_form")
+		if (@GAFYD)
+			settings['custom_reply_to'] = form.field_with(:name => 'param.custom_reply_to').value.strip
+			form.field_with(:name => 'param.max_size').options.each do |s|
+				settings['max_size'] = s.value if s.selected?
+			end
+			settings['reply_with_bounce_list']  = form.checkbox_with(:name => 'param.reply_with_bounce_list').checked?
+		end
+		settings['subject_tag'] = form.field_with(:name => 'param.subject_tag').value.strip
+		form.radiobuttons_with(:name => 'param.footer').each do |r|
+			settings['message_footer'] = "none" if r.checked?  && r.value == 'n'
+			settings['message_footer'] = "default" if r.checked?  && r.value == 'd'
+			settings['message_footer'] = "custom" if r.checked?  && r.value == 'c'
+		end
+		settings['reply_to'] = form.field_with(:name => 'param.footer_text').value.strip
+		form.radiobuttons_with(:name => 'param.reply_to').each do |r|
+			settings['reply_to'] = "whole_group" if r.checked?  && r.value == 'l'
+			settings['reply_to'] = "author" if r.checked?  && r.value == 'a'
+			settings['reply_to'] = "owner" if r.checked?  && r.value == 'o'
+			settings['reply_to'] = "user_decide" if r.checked?  && r.value == 'n'
+			settings['reply_to'] = "custom" if r.checked?  && r.value == 'c'
+		end
+		settings['posting_as_group']  = form.checkbox_with(:name => 'param.posting_as_group').checked?
+		settings['moderation_notify']  = form.checkbox_with(:name => 'param.moderation_notify').checked?
+		settings['moderation_message_text'] = form.field_with(:name => 'param.footer_text').value.strip
+
+		page = @scraper.get(@BASE_URL + group + @@ADV_SETTINGS)
+		form = page.form_with(:id => "GM_form")
+		form.field_with(:name => 'param.lang').options.each do |s|
+			settings['primary_language'] = s.value if s.selected?
+		end
+		settings['fixed_font']  = form.checkbox_with(:name => 'param.font_type').checked?
+		settings['no_archive_msgs']  = form.checkbox_with(:name => 'param.no_archive').checked?
+		settings['group_is_archived']  = form.checkbox_with(:name => 'param.status_archive').checked?
+		settings['google_contact']  = form.checkbox_with(:name => 'param.can_contact').checked?
+		
+		page = @scraper.get(@BASE_URL + group + @@SPAM_SETTINGS)
+		form = page.form_with(:id => "GM_form")
+		form.radiobuttons_with(:name => 'param.spam_mode').each do |r|
+			settings['spam_mode'] = "post" if r.checked?  && r.value == '0'
+			settings['spam_mode'] = "mod" if r.checked?  && r.value == '1'
+			settings['spam_mode'] = "mod_quiet" if r.checked?  && r.value == '3'
+			settings['spam_mode'] = "reject" if r.checked?  && r.value == '2'
+		end
+		return settings
+	end
+	
 end
 
-# monkey-patch Mechanize so we can't reuse ssl sessions
+# monkey-patch Mechanize::HTTP::Agent so we can't reuse ssl sessions
 # as that seems to break things
 class Mechanize::HTTP::Agent
     def reuse_ssl_sessions
@@ -134,6 +244,8 @@ class Mechanize::HTTP::Agent
     end
 end
 
+# monkey-patch Mechanize so we can't reuse ssl sessions
+# as that seems to break things
 class Mechanize
     def reuse_ssl_sessions
         @agent.reuse_ssl_sessions

data/rgroups.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "rgroups"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Andrew Hayworth"]
+  s.date = "2012-06-18"
+  s.description = "This is a Ruby API for accessing and updating Google Groups. It's based on Mechanize, which means it's essentially screen-scraping."
+  s.email = "ahayworth@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rgroups.rb",
+    "rgroups.gemspec",
+    "test/helper.rb",
+    "test/test_rgroups.rb"
+  ]
+  s.homepage = "http://github.com/ahayworth/rgroups"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Ruby API for accessing/updating Google Groups - based on Mechanize"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mechanize>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<mechanize>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mechanize>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rgroups
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Andrew Hayworth
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-17 00:00:00 Z
+date: 2012-06-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -122,6 +122,7 @@ files:
 - Rakefile
 - VERSION
 - lib/rgroups.rb
+- rgroups.gemspec
 - test/helper.rb
 - test/test_rgroups.rb
 homepage: http://github.com/ahayworth/rgroups