yahoo-group-data 0.1.0 → 1.0.0

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-test/yahoo_pages/*.html
+test/yahoo_pages/*.html
+coverage

data/README.md

@@ -1,6 +1,6 @@
 # yahoo-group-data gem
 
-Yahoo doesn't provide an API to it's publicly available group info, so this gem covers that gap. Use it to find out the publicly available group information of a Yahoo group such as name, description and relevant email addresses.
+Yahoo doesn't provide an API to it's publicly available group info, so this gem covers that gap. Use it to find information about a Yahoo group such as name, description and relevant email addresses.
 
 ## Example
 
@@ -83,6 +83,8 @@ after that:
 
 	$ rake test
 
+Because of the dynamic nature of Yahoo groups it's quite possible that the number of members a group has in groups.yml will have diverged with the number of members in reality when you pull down the pages using "rake fetch_yahoo_pages". If you see any of these divergences just update groups.yml appropriately.
+
 ### If you find a group the gem fails on
 
 Tell me about it, or (in preference) update the gem (Hint: start by adding an entry to the groups.yml file), see contributing instructions above.

data/lib/yahoo-group-data/version.rb

@@ -1,3 +1,3 @@
 class YahooGroupData
-	VERSION = "0.1.0"
+	VERSION = "1.0.0"
 end

data/lib/yahoo-group-data.rb

@@ -4,6 +4,7 @@ require 'curb'
 require 'uri'
 require 'nokogiri'
 require 'date'
+require 'yajl'
 
 class YahooGroupData
 	def initialize(url)
@@ -16,7 +17,11 @@ class YahooGroupData
 	end
 
 	def name
-		@name ||= no_data? ? nil : doc.css('span.ygrp-pname').first.content
+		@name ||= if not_found? || age_restricted?
+				nil
+			else
+				doc.css('span.ygrp-pname').first.content
+			end
 	end
 
 	def description
@@ -43,10 +48,8 @@ class YahooGroupData
 	end
 
 	def private?
-		@private_group ||= (
-			doc.xpath('/html/body/div[3]/center/p/big').size > 0 and
-			doc.xpath('/html/body/div[3]/center/p/big').first.content.strip.match(/Sorry, this group is available to members ONLY./i)
-		) ? true : false
+		return nil if not_found? || matches_age_restricted?
+		matches_private?
 	end
 
 	def not_found?
@@ -59,7 +62,8 @@ class YahooGroupData
 	end
 
 	def age_restricted?
-		@age_restricted ||= (doc.xpath('/html/body/div[3]/div/div/div/h4').size > 0 and doc.xpath('/html/body/div[3]/div/div/div/h4').first.inner_html.strip.match(/You've reached an Age-Restricted Area/i)) ? true : false
+		return nil if not_found? or matches_private?
+		matches_age_restricted?
 	end
 
 	def founded
@@ -71,16 +75,50 @@ class YahooGroupData
 	end
 
 	def num_members
-		Integer(doc.xpath('//ul[@class="ygrp-ul ygrp-info"]//li[1]').inner_html.split(':')[1].strip)
+		@num_members ||= no_data? ? nil : Integer(doc.xpath('//ul[@class="ygrp-ul ygrp-info"]//li[1]').inner_html.split(':')[1])
 	end
 
 	def category
 		return unless has_category?
-		doc.xpath('/html/body/div[3]/table/tr/td/div[2]/div[2]/div/ul/li[2]/a').inner_html
+		@category ||= no_data? ? nil : doc.xpath('/html/body/div[3]/table/tr/td/div[2]/div[2]/div/ul/li[2]/a').inner_html
+	end
+
+	def to_json
+
+		data_methods = %w{
+			private?
+			not_found?
+			age_restricted?
+			name
+			description
+			post_email
+			subscribe_email
+			owner_email
+			unsubscribe_email
+			language
+			num_members
+			category
+			founded
+		}
+
+		data_hash = {}
+		data_methods.map {|dm| data_hash[dm.tr('?', '')] = send(dm)}
+		Yajl::Encoder.encode(data_hash)
 	end
 
 	private
 
+	def matches_private?
+		@matches_private ||= (
+			doc.xpath('/html/body/div[3]/center/p/big').size > 0 and
+			doc.xpath('/html/body/div[3]/center/p/big').first.content.strip.match(/Sorry, this group is available to members ONLY./i)
+		) ? true : false
+	end
+
+	def matches_age_restricted?
+		@matches_age_restricted ||= (doc.xpath('/html/body/div[3]/div/div/div/h4').size > 0 and doc.xpath('/html/body/div[3]/div/div/div/h4').first.inner_html.strip.match(/You've reached an Age-Restricted Area/i)) ? true : false
+	end
+
 	def no_data?
 		private? or age_restricted? or not_found?
 	end

data/test/groups.yml

@@ -8,7 +8,7 @@ groups:
     not_found: false
     private: false
     age_restricted: false
-    founded: Jun 24, 2008
+    founded: 2008-06-24
     language: English
     num_members: 151
     category: COBOL
@@ -25,9 +25,9 @@ groups:
     not_found: false
     private: false
     age_restricted: false
-    founded: Aug 24, 2011
+    founded: 2011-08-24
     language: English
-    num_members: 160
+    num_members: 164
     category: Recycling
     post_email: Cambridge-Freegle@yahoogroups.com
     subscribe_email: Cambridge-Freegle-subscribe@yahoogroups.com
@@ -93,7 +93,7 @@ groups:
     not_found: false
     private: false
     age_restricted: false
-    founded: Sep 13, 2009
+    founded: 2009-09-13
     language: English
     num_members: 1
     category: Recycling
@@ -110,9 +110,9 @@ groups:
     not_found: false
     private: false
     age_restricted: false
-    founded: Mar 30, 2007
+    founded: 2007-03-30
     language: English
-    num_members: 2985
+    num_members: 2973
     category: 
     post_email: redcar-cleveland-freegle@yahoogroups.com
     subscribe_email: redcar-cleveland-freegle-subscribe@yahoogroups.com
@@ -120,14 +120,14 @@ groups:
     unsubscribe_email: redcar-cleveland-freegle-unsubscribe@yahoogroups.com
 
     # Foreign language, particularly for the date format
-  - id: 
+  - id: freecycle-michelstadt
     url: http://de.groups.yahoo.com/group/freecycle-michelstadt/
     name: freecycle-michelstadt
     description: Freecycle Michelstadt / Odenwald
     not_found: false
     private: false
     age_restricted: false
-    founded: Mai 6, 2004
+    founded: 2004-05-06
     language: Deutsch
     num_members: 63
     category: Kostenlos

data/test/test_helper.rb

@@ -1,13 +1,7 @@
 # encoding: utf-8
-def date_str_to_english(date_str)
-	date_str.
-		gsub(/ene/i, "Jan").
-		gsub(/fév|fev/i, "Feb").
-		gsub(/mar|mrz/i, "Mar").
-		gsub(/avr|abr/i, "Apr").
-		gsub(/mai|maj/i, "May").
-		gsub(/aoû|ago/i, "Aug").
-		gsub(/set/i, "Sep").
-		gsub(/okt|out/i, "Oct").
-		gsub(/déc|dez|dic/i, "Dec")
-end
+
+require 'simplecov'
+SimpleCov.start do
+	add_filter "/test/"
+	add_filter "lib/yahoo-group-data/version.rb"
+end

data/test/test_yahoo_group_data.rb

@@ -3,8 +3,35 @@ require 'test_helper'
 require 'webmock/test_unit'
 require 'yahoo-group-data'
 require 'date'
+require 'yajl'
 
 class YahooGroupDataTest < Test::Unit::TestCase
+
+	def test_to_json		
+		YAML.load_file('test/groups.yml')["groups"].each do |original_group|
+			stub_request(:get, original_group["url"]).
+				to_return(:status => 200, :body => File.read("test/yahoo_pages/#{original_group['id']}.html"), :headers => {})
+
+			g = YahooGroupData.new(original_group["url"])
+			puts original_group["url"]
+			data = Yajl::Parser.parse(g.to_json)
+
+			assert_equal original_group['private'], data['private']
+			assert_equal original_group['not_found'], data['not_found']
+			assert_equal original_group['age_restricted'], data['age_restricted']
+			assert_equal original_group['name'], data['name']
+			assert_equal original_group['description'], data['description']
+			assert_equal original_group['post_email'], data['post_email']
+			assert_equal original_group['subscribe_email'], data['subscribe_email']
+			assert_equal original_group['owner_email'], data['owner_email']
+			assert_equal original_group['unsubscribe_email'], data['unsubscribe_email']
+			assert_equal (original_group['founded'].nil? ? nil : original_group['founded'].strftime('%Y-%m-%d')), data['founded']
+			assert_equal original_group['language'], data['language']
+			assert_equal original_group['num_members'], data['num_members']
+			assert_equal original_group['category'], data['category']
+		end
+	end
+
 	def test_initialize_with_invalid_params
 		assert_raise(ArgumentError)  { YahooGroupData.new }
 	end
@@ -37,36 +64,25 @@ class YahooGroupDataTest < Test::Unit::TestCase
 	# (see the README on how to download them)
 	# then runs the assertions on each one.
 	def test_data_extraction
-		groups = YAML.load_file('test/groups.yml')["groups"]
-		groups.each do |g_data|
+		YAML.load_file('test/groups.yml')["groups"].each do |g_data|
 			puts "fetching #{g_data["url"]}"
 			stub_request(:get, g_data["url"]).
 			to_return(:status => 200, :body => File.read("test/yahoo_pages/#{g_data['id']}.html"), :headers => {})
 
 			group = YahooGroupData.new(g_data["url"])
-			if g_data["not_found"]
-				assert_equal g_data["not_found"], group.not_found?
-			elsif g_data["private"]
-				assert_equal g_data["not_found"], group.not_found?
-				assert_equal g_data["private"], group.private?
-			elsif g_data["age_restricted"]
-				assert_equal g_data["not_found"], group.not_found?
-				assert_equal g_data["age_restricted"], group.age_restricted?
-			else
-				assert_equal g_data["age_restricted"], group.age_restricted?
-				assert_equal g_data["private"], group.private?
-				assert_equal g_data["not_found"], group.not_found?
-				assert_equal g_data["name"], group.name
-				assert_equal g_data["description"], group.description
-				assert_equal g_data["post_email"], group.post_email
-				assert_equal g_data["subscribe_email"], group.subscribe_email
-				assert_equal g_data["owner_email"], group.owner_email
-				assert_equal g_data["unsubscribe_email"], group.unsubscribe_email
-				assert_equal Date.parse(date_str_to_english(g_data["founded"])), group.founded
-				assert_equal g_data["language"], group.language
-				assert_equal g_data["num_members"], group.num_members
-				assert_equal g_data["category"], group.category
-			end
+			assert_equal g_data["age_restricted"], group.age_restricted?
+			assert_equal g_data["private"], group.private?
+			assert_equal g_data["not_found"], group.not_found?
+			assert_equal g_data["name"], group.name
+			assert_equal g_data["description"], group.description
+			assert_equal g_data["post_email"], group.post_email
+			assert_equal g_data["subscribe_email"], group.subscribe_email
+			assert_equal g_data["owner_email"], group.owner_email
+			assert_equal g_data["unsubscribe_email"], group.unsubscribe_email
+			assert_equal g_data["founded"], group.founded
+			assert_equal g_data["language"], group.language
+			assert_equal g_data["num_members"], group.num_members
+			assert_equal g_data["category"], group.category
 		end
 	end
 end

data/yahoo-group-data.gemspec

@@ -16,6 +16,8 @@ Gem::Specification.new do |gem|
   gem.version       = YahooGroupData::VERSION
 
   gem.add_dependency 'nokogiri', '~> 1.5'
+  gem.add_dependency 'yajl-ruby', '~> 1.1'
   gem.add_dependency 'curb', '~> 0.8'
   gem.add_development_dependency 'webmock'
+  gem.add_development_dependency 'simplecov'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yahoo-group-data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000 Z
+date: 2012-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70145628826300 !ruby/object:Gem::Requirement
+  requirement: &70311668310240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: '1.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70145628826300
+  version_requirements: *70311668310240
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70311668309540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70311668309540
 - !ruby/object:Gem::Dependency
   name: curb
-  requirement: &70145628825740 !ruby/object:Gem::Requirement
+  requirement: &70311668308520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +43,21 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70145628825740
+  version_requirements: *70311668308520
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70145628825320 !ruby/object:Gem::Requirement
+  requirement: &70311668308100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70311668308100
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70311668307600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70145628825320
+  version_requirements: *70311668307600
 description: A lib to fetch public Yahoo group data
 email:
 - will@willj.net