yahoo-group-data 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/yahoo_pages/*.html

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Will Jessop
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# 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.
+
+## Example
+
+``` ruby
+require 'yahoo-group-data'
+
+g = YahooGroupData.new("http://tech.groups.yahoo.com/group/OneStopCOBOL/")
+
+name = g.name
+description = g.description
+
+p = g.post_email
+s = g.subscribe_email
+u = g.unsubscribe_email
+o = g.unsubscribe_email
+```
+
+## Requirements
+
+It's tested with Ruby 1.9.3, it probably works with older versions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yahoo-group-data'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yahoo-group-data
+
+## TODO
+
+* Parse out
+* * Number of members
+* * Founded date
+* * Category
+* * Language
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+*pull requests with tests are more likely to be accepted*
+
+### Testing
+
+Rather than distribute a load of Yahoo's HTML pages with the gem there's a rake task to get the ones that are needed. Run:
+
+	`rake fetch_yahoo_pages`
+
+after that:
+
+	rake test
+
+### 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/Rakefile

@@ -0,0 +1,30 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test
+
+desc "Fetch Yahoo Group pages for fixtures"
+task :fetch_yahoo_pages do
+	require 'yaml'
+	require 'curb'
+	groups = YAML.load_file('test/groups.yml')["groups"]
+	total_groups = 0
+	groups.each do |g|
+		curb = Curl::Easy.new(g["url"])
+  		curb.follow_location = true
+  		curb.http_get
+
+		File.open("test/yahoo_pages/#{g['id']}.html", "w") {|f| f.write curb.body_str }
+		print "."
+		total_groups += 1
+	end
+	puts
+	puts "#{total_groups} group pages fetched"
+end

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

@@ -0,0 +1,3 @@
+class YahooGroupData
+	VERSION = "0.0.1"
+end

data/lib/yahoo-group-data.rb

@@ -0,0 +1,65 @@
+# encoding: utf-8
+require 'yahoo-group-data/version'
+require 'curb'
+require 'uri'
+require 'nokogiri'
+
+class YahooGroupData
+	def initialize(url)
+		raise ArgumentError "A URL must be passed" unless url
+		
+		curb = Curl::Easy.new(url)
+		curb.follow_location = true
+		curb.http_get
+		@html = curb.body_str
+	end
+
+	def name
+		doc.css('span.ygrp-pname').first.content
+	end
+
+	def description
+		element = doc.css('span.ygrp-grdescr')
+		if element.size > 0
+			doc.css('span.ygrp-grdescr').first.content.gsub(/\A[·\s]*/, "")
+		end
+	end
+
+	def post_email
+		subscribe_email.gsub("-subscribe@", "@")
+	end
+
+	def subscribe_email
+		doc.css('div#ygrp-links div.ygrp-contentblock').first.content.match(/(\S*-subscribe@[a-z]*yahoo[a-z]*\.[a-z\.]+)/)[1]
+	end
+
+	def owner_email
+		doc.css('div#ygrp-links div.ygrp-contentblock').first.content.match(/(\S*-owner@[a-z]*yahoo[a-z]*\.[a-z\.]+)/)[1]
+	end
+
+	def unsubscribe_email
+		doc.css('div#ygrp-links div.ygrp-contentblock').first.content.match(/(\S*-unsubscribe@[a-z]*yahoo[a-z]*\.[a-z\.]+)/)[1]
+	end
+
+	def private?
+		@private_group ||= (
+			not_found_element = doc.xpath('/html/body/div[3]/center/p/big')
+			not_found_element.size > 0 and not_found_element.first.content.strip.match(/Sorry, this group is available to members ONLY./i) ? true : false
+		)
+	end
+
+	def defunct?
+		@defunct ||= (
+			not_found_element = doc.xpath('/html/body/div[3]/div/div/div/h3')
+			not_found_element.size > 0 and not_found_element.first.content.strip.match(/Group Not Found|Group nicht gefunden/i) ? true : false
+		)
+	end
+
+	private
+
+	attr_reader :html, :doc, :defunct #, :private_group
+
+	def doc
+		@doc ||= Nokogiri::HTML(html)
+	end
+end

data/test/groups.yml

@@ -0,0 +1,40 @@
+---
+groups:
+  - id: OneStopCOBOL
+    url: http://tech.groups.yahoo.com/group/OneStopCOBOL/
+    name: OneStopCOBOL
+    description: OneStopCOBOL - Official COBOL group
+    defunct: false
+    post_email: OneStopCOBOL@yahoogroups.com
+    subscribe_email: OneStopCOBOL-subscribe@yahoogroups.com
+    owner_email: OneStopCOBOL-owner@yahoogroups.com
+    unsubscribe_email: OneStopCOBOL-unsubscribe@yahoogroups.com
+
+  - id: Cambridge-Freegle
+    url: http://groups.yahoo.com/group/Cambridge-Freegle/
+    name: Cambridge-Freegle
+    description: 
+    defunct: false
+    post_email: Cambridge-Freegle@yahoogroups.com
+    subscribe_email: Cambridge-Freegle-subscribe@yahoogroups.com
+    owner_email: Cambridge-Freegle-owner@yahoogroups.com
+    unsubscribe_email: Cambridge-Freegle-unsubscribe@yahoogroups.com
+
+  - id: Freecycle_MV
+    url: http://groups.yahoo.com/group/Freecycle_MV/
+    defunct: true
+
+  - id: blackpool-freecycle
+    url: http://groups.yahoo.com/group/blackpool-freecycle/
+    defunct: false
+    private: true
+
+  - id: Dursleyfreecycle
+    url: http://groups.yahoo.com/group/Dursleyfreecycle/
+    name: DursleyFreecycle
+    description: DursleyFreecycle(R)
+    defunct: false
+    post_email: DursleyFreecycle@yahoogroups.co.uk
+    subscribe_email: DursleyFreecycle-subscribe@yahoogroups.co.uk
+    owner_email: DursleyFreecycle-owner@yahoogroups.co.uk
+    unsubscribe_email: DursleyFreecycle-unsubscribe@yahoogroups.co.uk

data/test/test_yahoo_group_data.rb

@@ -0,0 +1,56 @@
+require 'test/unit'
+require 'webmock/test_unit'
+require 'yahoo-group-data'
+
+class YahooGroupDataTest < Test::Unit::TestCase
+	def test_initialize_with_invalid_params
+		assert_raise(ArgumentError)  { YahooGroupData.new }
+	end
+
+	def test_initialize_with_valid_params
+		url = "http://tech.groups.yahoo.com/group/OneStopCOBOL/"
+
+		stub_request(:get, url).
+		to_return(:status => 200, :body => "", :headers => {})
+
+		g = YahooGroupData.new(url)
+		assert_equal g.class, YahooGroupData
+		assert_requested :get, url
+	end
+
+	def test_handling_redirects
+		url = "http://tech.groups.yahoo.com/group/OneStopCOBOL"
+		stub_request(:get, url).
+		to_return(:status => 302, :headers => { 'Location' => "#{url}/" })
+		stub_request(:get, "#{url}/").
+		to_return(:status => 200, :body => "", :headers => {})
+
+		g = YahooGroupData.new(url)
+		assert_equal g.class, YahooGroupData
+		assert_requested :get, url
+		assert_requested :get, "#{url}/"
+	end
+
+	# This method will loop over all the html files
+	# (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|
+			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"])
+			unless g_data["defunct"] or g_data["private"]
+				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
+			end
+			assert_equal g_data["defunct"], group.defunct?
+		end
+	end
+end

data/yahoo-group-data.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yahoo-group-data/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Will Jessop"]
+  gem.email         = ["will@willj.net"]
+  gem.description   = %q{A lib to fetch public Yahoo group data}
+  gem.summary       = %q{A lib to fetch the publicly available Yahoo group data from a Yahoo groups page}
+  gem.homepage      = "https://github.com/wjessop/yahoo-group-data"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "yahoo-group-data"
+  gem.require_paths = ["lib"]
+  gem.version       = YahooGroupData::VERSION
+
+  gem.add_dependency 'nokogiri', '~> 1.5'
+  gem.add_dependency 'curb', '~> 0.8'
+  gem.add_development_dependency 'webmock'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: yahoo-group-data
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Will Jessop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70185747420720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70185747420720
+- !ruby/object:Gem::Dependency
+  name: curb
+  requirement: &70185747420160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70185747420160
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70185747419720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70185747419720
+description: A lib to fetch public Yahoo group data
+email:
+- will@willj.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yahoo-group-data.rb
+- lib/yahoo-group-data/version.rb
+- test/groups.yml
+- test/test_yahoo_group_data.rb
+- test/yahoo_pages/.gitkeep
+- yahoo-group-data.gemspec
+homepage: https://github.com/wjessop/yahoo-group-data
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A lib to fetch the publicly available Yahoo group data from a Yahoo groups
+  page
+test_files:
+- test/groups.yml
+- test/test_yahoo_group_data.rb
+- test/yahoo_pages/.gitkeep