vanity-source 0.9 → 0.10

data/CHANGELOG

@@ -1,3 +1,9 @@
+2010-08-26 v0.10 Tags and better messages
+
+Activities can now include tags.
+
+Improvement all around to all the HTML messages.
+
 2010-08-25 v0.9 Better Github commit message
 
 2010-08-24 v0.8 Minor API change

data/lib/vanity/source.rb

@@ -69,6 +69,24 @@ module Vanity
   #   be positive or negative. This is a hash where the keys are column ids (or
   #   indexes), the values are integers or floats.
   # * timestamp -- The Time (if missing, uses the current system time).
+  # * activity -- Activity to show in the stream. See below.
+  #
+  # Activity can specify the following attributes:
+  # * uid -- Unique identifier (within the scope of this source). For example,
+  #   if activity is a release, this could be the version number.
+  # * html -- HTML contents of the activity.
+  # * text -- Text contents of the activity (can be used instead of html).
+  # * url -- URL for original resource (e.g. blog post, tweet).
+  # * tags -- Any number of tags for filtering activities like this (e.g.
+  #   twitter, mention). Tags are lowercased and can contain alphanumeric,
+  #   dashes and underscore.
+  # * person -- Person who performed this activity. A hash with the (all
+  #   optional) values :name, :email, :url and :photo.
+  # * timestamp -- Timestamp activity occurred.
+  #
+  # HTML can contain links (HTTP/S and email), images, bold, italics,
+  # paragraphs, block quotes, lists, tables, pre-formatted text, video and a few
+  # other elements. Scripts, objects, styles are obviously not allowed. 
   #
   # Occasionally, the #meta method is called. This method is used to display
   # meta-data from the most recent state (i.e. last update). It returns an array

data/lib/vanity/sources/backtweets.rb

@@ -32,7 +32,12 @@ module Vanity
               new_ones = tweets.take_while { |tweet| tweet["tweet_id"] != last_tweet_id }.reverse
               new_ones.each do |tweet|
                 handle, id = tweet["tweet_from_user"], tweet["tweet_id"]
-                block.call :activity=>{ :uid=>id, :html=>tweet["tweet_text"], :url=>"http://twitter.com/#{handle}/#{id}",
+                url = "http://twitter.com/#{handle}/#{id}"
+                html = <<-HTML
+<a href="#{url}">tweeted</a>:
+<blockquote>#{tweet["tweet_text"]}</blockquote>
+                HTML
+                block.call :activity=>{ :uid=>id, :url=>url, :html=>html, :tags=>%w{twitter mention},
                                         :timestamp=>Time.parse(tweet["tweet_created_at"]).utc,
                                         :person=>{ :name=>handle, :url=>"http://twitter.com/#{handle}", :photo=>tweet["tweet_profile_image_url"] } }
               end

data/lib/vanity/sources/github.rb

@@ -54,11 +54,11 @@ module Vanity
               new_ones = commits.take_while { |commit| commit["id"] != last_seen_id }
               new_ones.reverse.each do |commit|
                 committer = commit["committer"]
-                message = <<-HTML
-<p>committed to <code>#{h context["repo"]}</code> in branch <code>#{h context["branch"]}</code>:</p>
-<pre>#{h commit["message"]}</pre>
+                html = <<-HTML
+pushed to #{h context["branch"]} at <a href="http://github.com/#{context["repo"]}">#{h context["repo"]}</a>:
+<blockquote><a href="#{commit["url"]}">#{commit["id"][0,7]}</a> #{h commit["message"]}</blockquote>
                 HTML
-                block.call :activity=>{ :uid=>commit["id"], :html=>message, :url=>commit["url"],
+                block.call :activity=>{ :uid=>commit["id"], :html=>html, :url=>commit["url"], :tags=>"push",
                                         :timestamp=>Time.parse(commit["committed_date"]).utc,
                                         :person=>{ :name=>committer["name"], :url=>"http://github.com/#{committer["name"]}",
                                                    :email=>committer["email"] } }

data/lib/vanity/sources/github_issues.rb

@@ -37,9 +37,13 @@ module Vanity
             if open_ids = context["open-ids"]
               open.reject { |issue| open_ids.include?(issue["number"]) }.reverse.each do |issue|
                 sha = Digest::SHA1.hexdigest([context["repo"], "open", issue["number"], issue["updated_at"]].join(":"))
-                block.call :activity=>{ :uid=>sha, :text=>"New issue opened: #{issue["title"]}",
-                  :url=>"http://github.com/#{context["repo"]}/issues#issue/#{issue["number"]}",
-                  :timestamp=>Time.parse(issue["created_at"]).utc }
+                url = "http://github.com/#{context["repo"]}/issues#issue/#{issue["number"]}"
+                html = <<-HTML
+opened <a href="#{url}">issue #{issue["number"]}</a> on #{context["repo"]}:
+<blockquote>#{h issue["title"]}</blockquote>
+                HTML
+                block.call :activity=>{ :uid=>sha, :url=>url, :html=>html, :tags=>%w{issue opened},
+                                        :timestamp=>Time.parse(issue["created_at"]).utc }
               end
             end
             context["open-ids"] = open.map { |issue| issue["number"] }
@@ -54,9 +58,13 @@ module Vanity
             if closed_ids = context["closed-ids"]
               closed.reject { |issue| closed_ids.include?(issue["number"]) }.reverse.each do |issue|
                 sha = Digest::SHA1.hexdigest([context["repo"], "closed", issue["number"], issue["updated_at"]].join(":"))
-                block.call :activity=>{ :uid=>sha, :text=>"Issue closed: #{issue["title"]}",
-                  :url=>"http://github.com/#{context["repo"]}/issues#issue/#{issue["number"]}",
-                  :timestamp=>Time.parse(issue["closed_at"]).utc }
+                url = "http://github.com/#{context["repo"]}/issues#issue/#{issue["number"]}"
+                html = <<-HTML
+closed <a href="#{url}">issue #{issue["number"]}</a> on #{context["repo"]}:
+<blockquote>#{h issue["title"]}</blockquote>
+                HTML
+                block.call :activity=>{ :uid=>sha, :url=>url, :html=>html, :tags=>%w{issue closed},
+                                        :timestamp=>Time.parse(issue["closed_at"]).utc }
               end
             end
             context["closed-ids"] = closed.map { |issue| issue["number"] }

data/lib/vanity/sources/ruby_gems.rb

@@ -33,8 +33,9 @@ module Vanity
         if context["version"]
           current, latest = Gem::Version.new(context["version"]), Gem::Version.new(json["version"])
           if latest > current
+            html = "released <a href=\"http://rubygems.org/gems/#{gem_name}/versions/#{latest}\">#{gem_name} version #{latest}</a>."
             yield :activity=>{ :uid=>"#{gem_name}-#{latest}", :url=>"http://rubygems.org/gems/#{gem_name}",
-                               :html=>"Released <a href=\"http://rubygems.org/gems/#{gem_name}/versions/#{latest}\">#{gem_name} version #{latest}</a>" }
+                               :html=>html, :tags=>%w{release} }
           end
         end
         context["version"] = json["version"]

data/test/backtweets_test.rb

@@ -90,7 +90,10 @@ test Vanity::Source::Backtweets do
         end
 
         should "capture tweet text" do
-          assert_equal "Super awesome <a href=\"http://vanity.labnotes.org/\">http://j.mp/aOrUnsz</a>", activity.html
+          assert_equal <<-HTML, activity.html
+<a href="http://twitter.com/assaf/20959239300">tweeted</a>:
+<blockquote>Super awesome <a href="http://vanity.labnotes.org/">http://j.mp/aOrUnsz</a></blockquote>
+          HTML
         end
 
         should "capture tweet URL" do
@@ -113,6 +116,10 @@ test Vanity::Source::Backtweets do
           assert_equal "http://twitter.com/account/profile_image/assaf", activity.person.photo
         end
 
+        should "tag as tweeter and mention" do
+          assert_contains activity.tags, "twitter"
+          assert_contains activity.tags, "mention"
+        end
       end
 
     end

data/test/github_issues_test.rb

@@ -129,7 +129,15 @@ test Vanity::Source::GithubIssues do
         end
 
         should "capture issue title" do
-          assert_equal "New issue opened: Option to use Google Analytics for A/B testing", @open.text
+          assert_equal <<-HTML, @open.html
+opened <a href="http://github.com/assaf/vanity/issues#issue/22">issue 22</a> on assaf/vanity:
+<blockquote>Option to use Google Analytics for A/B testing</blockquote>
+          HTML
+        end
+
+        should "tag as issue and open" do
+          assert_contains @open.tags, "issue"
+          assert_contains @open.tags, "opened"
         end
       end
 
@@ -151,7 +159,15 @@ test Vanity::Source::GithubIssues do
         end
 
         should "capture issue title" do
-          assert_equal "Issue closed: Passwords not supported for the Redis config", @closed.text
+          assert_equal <<-HTML, @closed.html
+closed <a href="http://github.com/assaf/vanity/issues#issue/19">issue 19</a> on assaf/vanity:
+<blockquote>Passwords not supported for the Redis config</blockquote>
+          HTML
+        end
+
+        should "tag as issue and closed" do
+          assert_contains @closed.tags, "issue"
+          assert_contains @closed.tags, "closed"
         end
       end
 

data/test/github_test.rb

@@ -139,10 +139,10 @@ test Vanity::Source::Github do
           assert_equal Time.parse("2010-08-06T00:22:01-07:00 UTC"), activity.timestamp
         end
 
-        should "capture commit message" do
+        should "capture commit message and SHA1" do
           assert_equal <<-HTML, activity.html
-<p>committed to <code>assaf/vanity</code> in branch <code>master</code>:</p>
-<pre>Third &amp; last</pre>
+pushed to master at <a href="http://github.com/assaf/vanity">assaf/vanity</a>:
+<blockquote><a href="http://github.com/assaf/vanity/commit/dd154a9fdd2ac534b62b55b8acac2fd092d65439">dd154a9</a> Third &amp; last</blockquote>
           HTML
         end
 
@@ -154,6 +154,9 @@ test Vanity::Source::Github do
           assert_equal "assaf@labnotes.org", activity.person.email
         end
 
+        should "tag as push" do
+          assert_contains activity.tags, "push"
+        end
       end
 
     end

data/test/ruby_gems_test.rb

@@ -92,13 +92,19 @@ test Vanity::Source::RubyGems do
           assert_equal "vanity-2.1.0", activity.uid
         end
 
-        should "capture have body denoting release" do
-          assert_equal "Released <a href=\"http://rubygems.org/gems/vanity/versions/2.1.0\">vanity version 2.1.0</a>", activity.html
+        should "report release number" do
+          assert_equal <<-HTML.strip, activity.html
+released <a href=\"http://rubygems.org/gems/vanity/versions/2.1.0\">vanity version 2.1.0</a>.
+          HTML
         end
 
         should "link to project page" do
           assert_equal "http://rubygems.org/gems/vanity", activity.url
         end
+
+        should "tag as release" do
+          assert_contains activity.tags, "release"
+        end
       end
     end
   end

data/test/test.log

@@ -350,3 +350,153 @@ Backtweets: 200
 Backtweets: 500 
 RubyGems: 200 
 RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 
+Backtweets: 500 
+Backtweets: 200 
+Backtweets: 200 
+Backtweets: 500 
+RubyGems: 200 
+RubyGems: 500 

data/test/test_helper.rb

@@ -44,7 +44,7 @@ module Vanity
   module Source
     module TestHelpers
       # Represents an activity.
-      Activity = Struct.new(:uid, :html, :text, :url, :timestamp, :person)
+      Activity = Struct.new(:uid, :html, :text, :url, :timestamp, :tags, :person)
  
       # Represents person associated with activity. 
       Person = Struct.new(:name, :email, :url, :photo)
@@ -117,7 +117,7 @@ module Vanity
               totals[name] += value
             end
           elsif args[:activity]
-            values = args[:activity].values_at(:uid, :html, :text, :url, :timestamp)
+            values = args[:activity].values_at(:uid, :html, :text, :url, :timestamp, :tags)
             if person = args[:activity][:person]
               values << Person.new(*person.values_at(:name, :email, :url, :photo))
             end

data/vanity-source.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name           = "vanity-source"
-  spec.version        = "0.9"
+  spec.version        = "0.10"
   spec.author         = "Assaf Arkin"
   spec.email          = "assaf@labnotes.org"
   spec.homepage       = "http://vanitydash.com"

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: vanity-source
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
-  - 9
-  version: "0.9"
+  - 10
+  version: "0.10"
 platform: ruby
 authors: 
 - Assaf Arkin
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 -07:00
+date: 2010-08-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,7 +105,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --title
-- Vanity::Source 0.9
+- Vanity::Source 0.10
 - --main
 - README.rdoc
 - --webcvs