yammerstats 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+oauth.yml
+top_updaters.xml
+coverage/
+yammerstats-0.1.0.gem

data/README.rdoc

@@ -0,0 +1,32 @@
+= yammerstats
+
+* http://github.com/pmoran/yammerstats
+
+== DESCRIPTION:
+
+yammerstats is a simple command line tool for fetching data for a Yammer network and presenting it in a useful way. It runs a Yammer query and outputs the results using an ERB template.
+
+The first usage has been focused on generating 3D column charts using http://www.fusioncharts.com.
+
+== SYNOPSIS:
+
+yammerstats uses yammer4r to query a Yammer network. You will need to follow the steps described by yammer4r to register an application and create a credentials config file.
+
+* gem install yammer4r
+* ruby yammer4r/bin/yammer_create_oauth_yml.rb (and follow instructions in the script)
+
+To run a stats request, use:
+
+    yammerstats [options]
+
+== EXAMPLE USAGE:
+
+Run the default (and currently only) stat top_updaters, generating an xml file that can be consumed by Fusion Charts
+  yammerstats --config=oauth.yml
+
+
+== TODO
+
+* Gemify
+* Add possibly useful stats
+* Heat map of user posts - when is a user posting?

data/Rakefile

@@ -0,0 +1,35 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+ 
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_files = FileList['spec/**/*spec.rb']
+end
+
+Spec::Rake::SpecTask.new("rcov:spec") do |t|
+  t.spec_opts = ['--options', "\"spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "yammerstats"
+    gemspec.summary = "Fetch some (possibly) useful info from your Yammer domain"
+    gemspec.description = "Fetches Yammer information and outputs it to the format of your choice, using Erb templates."
+    gemspec.email = "workingpeter@gmail.com"
+    gemspec.homepage = "http://github.com/pmoran/yammerstats"
+    gemspec.authors = ["Peter Moran"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+task :default => [:spec]

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/yammerstats

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+ 
+require 'optparse'
+require 'yammerstats'
+
+OPTIONS = {
+  :config  => 'oauth.yml',
+  :stat => "top_updaters"
+}
+
+ARGV.options do |o|
+  script_name = File.basename($0)
+  
+  o.set_summary_indent('  ')
+  o.banner =    "Usage: #{script_name} [OPTIONS]"
+  o.define_head "Generate stats for your Yammer network"
+  o.separator   ""
+  
+  o.on("-c", "--config=val", String, "oauth config file", "Default: #{OPTIONS[:config]}") do |c|
+     OPTIONS[:config] = c
+  end
+  o.on("-s", "--stat=val", String, "Stat to run", "Default: #{OPTIONS[:stat]}") do |s|
+     OPTIONS[:stat] = s
+  end
+  o.on("-t", "--template=val", String, "Erb template file") do |t|
+    OPTIONS[:template] = t
+  end
+  o.on("-o", "--output=val", String, "Output file") do |o|
+     OPTIONS[:output] = o
+   end
+  o.on("-d", "--dump", "Dump results to the screen, rather than an output file") do |d|
+     OPTIONS[:dump] = d
+  end
+  o.on("--stub", "Stub Yammer client for testing purposes") do |s|
+     OPTIONS[:stub] = s
+  end
+  
+  o.separator ""
+
+  o.on_tail("-h", "--help", "Show this help message.") { puts o; exit }
+  o.parse!
+end
+
+require File.expand_path(File.dirname(__FILE__) + "../../lib/ext/yammer/client") if OPTIONS[:stub]
+
+stats = Yammer::Stats.new(:config => OPTIONS[:config], :verbose => false)
+stats.send(OPTIONS[:stat], OPTIONS)

data/examples/data/users.json

@@ -0,0 +1,12 @@
+[ 
+{
+"timezone":"Sydney","interests":null,"type":"user","contact": {"im":{"provider":"aim","username":""},"email_addresses": [{"type":"primary","address":"r.maldon@diuscomputing.com.au"} ],
+"phone_numbers":[]},"hire_date":null,"location":null,"guid":null,"job_title":"Software Craftsman","network_id":42785,"schools":[],"kids_names":null,"significant_other":null,"web_url":"https://www.yammer.com/diuscomputing.com.au/users/r-maldon","network_domains":["diuscomputing.com.au"],"id":481091,"mugshot_url":"https://assets3.yammer.com/user_uploaded/photos/p1/0044/5440/the-real-shaq_small.jpg","stats":{"updates":21,"following":31,"followers":32},"external_urls":[],
+"full_name":"THE_REAL_SHAQ","name":"r-maldon","url":"https://www.yammer.com/api/v1/users/481091","expertise":null,"summary":null,"previous_companies":[],"birth_date":"","network_name":"diuscomputing.com.au","state":"active"
+},
+{
+"timezone":"Melbourne","interests":null,"type":"user","contact":{"im":{"provider":"aim","username":""},"email_addresses":[{"type":"primary","address":"w.godfrey@diuscomputing.com.au"}],"phone_numbers":[{"type":"mobile","number":"0408409465"}]},"hire_date":null,"location":null,"guid":null,"job_title":"Developer","network_id":42785,"schools":[],"kids_names":null,"significant_other":null,"web_url":"https://www.yammer.com/diuscomputing.com.au/users/w-godfrey","network_domains":["diuscomputing.com.au"],
+"id":394365,"mugshot_url":"https://assets3.yammer.com/images/no_photo_small.gif","stats":{"updates":3,"following":27,"followers":38},"external_urls":[],
+"full_name":"Warner Godfrey","name":"x-godfrey","url":"https://www.yammer.com/api/v1/users/394365","expertise":null,"summary":null,"previous_companies":[],"birth_date":"","network_name":"diuscomputing.com.au","state":"active"
+}
+]

data/examples/html/top_updaters.html

@@ -0,0 +1,16 @@
+<html>
+<head>
+	<title>Yammer Stats</title>
+</head>
+<body bgcolor="#ffffff">
+<h2 align="center">Yammer Updates by User</h2>
+<div align="center">
+  <OBJECT classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" codebase=http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,0,0" width="800" height="400" >
+    <param name="movie" value="FCF_Column3D.swf" />
+    <param name="FlashVars" value="&dataURL=../data/top_updaters.xml&chartWidth=800&chartHeight=400">
+    <param name="quality" value="high" />
+    <embed src="FCF_Column3D.swf" width="800" height="400" flashVars="&dataURL=../data/top_updaters.xml&chartWidth=800&chartHeight=400" quality="high" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" />
+  </object>
+</div>
+</body>
+</html>

data/examples/templates/top_updaters.erb

@@ -0,0 +1,6 @@
+<% COLOURS = %w(AFD8F8, F6BD0F, 8BBA00, FF8E46, 008E8E, D64646, 8E468E, 588526, B3AA00, 008ED6, 9D080D, A186BE) %>
+<graph caption='Top Yammer Updaters' xAxisName='Users' yAxisName='Updates' showNames='1' decimalPrecision='0' formatNumberScale='0' rotateNames="1">
+<% users[0..12].sort_by{|u| u.name }.each_with_index do |user, i| %>
+  <set name='<%= user.name %>' value='<%= user.stats.updates %>' color='<%=COLOURS[i]%>' />
+<% end %>	
+</graph>    

data/lib/ext/yammer/client.rb

@@ -0,0 +1,15 @@
+module Yammer
+  class Client
+    
+    def users(options = {})
+      file = "examples/data/users.json"
+      p ("Yammer::Client stubbed. Reading users from #{file}")
+      s = IO.read(file)
+      JSON.parse(s).map do |u|
+        Yammer::User.new(mash(u), self)
+      end  
+    end
+    
+  end
+end
+

data/lib/yammer/stats.rb

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+module Yammer
+
+  class Stats
+
+    def initialize(options = {})
+      options.merge!(:config => "oauth.yml") unless options[:config]
+      @yammer = Yammer::Client.new(options)
+    end
+
+    def top_updaters(options = {})
+      users = @yammer.users(:sort_by => "messages", :reverse => false)
+      if options.delete(:dump) == true
+        users.each {|u| puts "#{u.name} - #{u.stats.updates}" }
+      else
+        template, output_file = options_or_defaults(options)
+        output = ERB.new(IO.read(template), nil, '<>').result(binding)
+        File.open(output_file, 'w') {|f| f.write(output)}      
+      end
+    end
+
+    private
+  
+    def options_or_defaults(options)
+      template = options.delete(:template) || 'examples/templates/top_updaters.erb'
+      output_file = options.delete(:output) || 'top_updaters.xml'
+      [template, output_file]
+    end
+  
+  end
+
+end

data/lib/yammerstats.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'erb'
+require 'ostruct'
+
+require 'yammer4r'
+require 'yammer/stats'

data/spec/rcov.opts

@@ -0,0 +1 @@
+--exclude "spec/*,gems/*"

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'yammerstats'
+require 'spec'

data/spec/yammer/stats_spec.rb

@@ -0,0 +1,55 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'ostruct'
+
+describe Yammer::Stats do
+  
+  it "initialises a yammer client" do
+    stats = Yammer::Stats.new
+    stats.instance_variable_get(:@yammer).should_not be_nil
+  end
+  
+  context "top updaters" do
+    
+    before(:each) do
+      @mock_yammer = mock(Yammer::Client)
+      @mock_yammer.stub!("users").and_return([OpenStruct.new(:name => "foo", :stats => OpenStruct.new(:updates => nil))])
+      Yammer::Client.stub!("new").and_return(@mock_yammer)
+    end
+    
+    it "can dump results to the screen" do
+      stats = Yammer::Stats.new
+      File.should_not_receive("open")
+      stats.top_updaters(:dump => true)
+    end
+    
+    describe "with files" do
+    
+      before(:each) do
+        @stats = Yammer::Stats.new
+        mock_erb = mock(ERB)
+        mock_erb.stub!("result")
+        ERB.stub!("new").and_return(mock_erb)
+      end
+    
+      it "uses default files if not specified" do
+        IO.should_receive("read").with("examples/templates/top_updaters.erb")
+        File.should_receive("open").with("top_updaters.xml", 'w')
+        @stats.top_updaters
+      end
+    
+      it "reads a specified template" do
+        File.stub!("open")      
+        IO.should_receive("read").with("foo/bar.erb")
+        @stats.top_updaters(:template => "foo/bar.erb")
+      end
+    
+      it "writes to a specified output file" do
+        File.should_receive("open").with("foo/myoutput.file", 'w')
+        @stats.top_updaters(:output => "foo/myoutput.file")
+      end
+
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: yammerstats
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Peter Moran
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +11:00
+default_executable: yammerstats
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yammer4r
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+    version: 
+description: Fetches Yammer information and outputs it to the format of your choice, using Erb templates.
+email: workingpeter@gmail.com
+executables: 
+- yammerstats
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/yammerstats
+- examples/data/users.json
+- examples/html/FCF_Column3D.swf
+- examples/html/top_updaters.html
+- examples/templates/top_updaters.erb
+- lib/ext/yammer/client.rb
+- lib/yammer/stats.rb
+- lib/yammerstats.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/yammer/stats_spec.rb
+has_rdoc: true
+homepage: http://github.com/pmoran/yammerstats
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Fetch some (possibly) useful info from your Yammer domain
+test_files: 
+- spec/spec_helper.rb
+- spec/yammer/stats_spec.rb