dash-fu 1.0.1 → 1.1.0

data/CHANGELOG

@@ -1,6 +1,12 @@
-1.0.1 on 2011-08-22
+1.1.0 on 2011-10-03
 
-Added require_paths to Gemspec.
+Added DashFu.log method.  This is experimental and will be nailed down by next
+minor update.
+
+Added multi_json as dependency, required for adding new activities.
+
+Renamed dash-fu.rb to dash_fu.rb, since this is the more common convention.  No
+change to Gem name yet.
 
 
 1.0.0 on 2011-08-19

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/dash-fu.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |spec|
   spec.summary        = "Use me to push data to Dash-fu in real time"
   spec.description    = ""
   spec.post_install_message = IO.read("README.md")
-  spec.license        = "Public domain"
+  spec.license          = "Public domain"
 
   spec.files          = Dir["{bin,lib,test}/**/*", "CHANGELOG", "VERSION", "README.md", "*.gemspec"]
-  spec.require_paths  = [ "lib" ]
 
   spec.required_ruby_version = '>= 1.8.7'
+  spec.add_dependency "multi_json"
 end

data/lib/dash_fu.rb

@@ -0,0 +1,187 @@
+require "socket"
+require 'multi_json'
+
+
+# Use me to push data to Dash-fu in real time.
+#
+#
+# The only configuration you need is setting the API key in
+# config/environments/production.rb:
+#
+#   DashFu.api_key = "<your API key>"
+#
+# You only want to push data in production, so make sure the API key is only set
+# in production environment.  Calls to created/active with no API key are
+# simply ignored.
+#
+#
+# You can send events by calling DashFu.push with UID and event, or using the
+# specialized created and active methods.
+#
+# For example, to assign a user to a cohort, we're going to notify Dash-fu
+# whenever an acount gets created:
+#
+#   class User < ActiveRecord::Model
+#     after_create do
+#       DashFu.created id
+#     end
+#   end
+#
+# In this example, we consider a user active whenever they post a status update,
+# and notify Dash-fu accordingly:
+#
+#   class StatusUpdate < ActiveRecord::Model
+#     after_create do
+#       DashFu.active id
+#     end
+#   end
+module DashFu
+  @mutex = Mutex.new
+
+  class << self
+    # DashFu.host is set by default, this is only useful for testing.
+    attr_accessor :host, :port
+
+    # Set the API key with:
+    #   DashFu.api_key = "<your API key>"
+    attr_accessor :api_key
+
+    # Logs an activity.  An activity has an actor (the user who performed the
+    # activity), the action performed (e.g. posted, commented) and the object of
+    # the action (e.g. the post).
+    #
+    # You can call this method with actor, action and optional object (two or
+    # three arguments), or with a Hash with the keys actor, action, object and
+    # timestamp.
+    #
+    # For example:
+    #   DashFu.log user, 'posted', post.title
+    #   DashFu.log actor: user, action: 'posted', object: { content: post.title }
+    #
+    #
+    # The actor argument is either the ID of a user, an object that responds to
+    # to_dashboard, or Hash with the following keys:
+    # - uid -- User identifier (must be unique in application, required)
+    # - created -- Date/time instance when user account was created
+    # - name -- Display name
+    # - email -- Email address
+    # - image -- URL for profile photo
+    # - url -- URL for profile
+    #
+    # UID is required, all other properties are optional.
+    #
+    # When using an object that responds to to_dashboard, the to_dashboard
+    # method must return a Hash with these keys.
+    #
+    #
+    # The action argument is any string, e.g. 'posted', 'commented'.
+    #
+    #
+    # The object argument is either a string containing HTML markup, an object
+    # that respobds to to_dashboard, or Hash with the following keys:
+    # - content -- HTML markup describing the object
+    #
+    # HTML markup may use semantic styling elements such as b, em, p,
+    # blockquote.  Styles and scripts are stripped, and only links to HTTP/S
+    # URLs are preserved.
+    #
+    # When using an object that responds to to_dashboard, the to_dashboard
+    # method must return a Hash with these keys.
+    #
+    #
+    # The timestamp argument is the date/time instance the activity occurred.
+    def log(*args)
+      return unless @api_key # in test/dev mode, return quickly
+
+      if args.length == 1 && args[0].respond_to?(:values_at)
+        actor, action, object, timestamp = args[0].values_at(:actor, :action, :object, :timestamp)
+      elsif args.length == 2 || args.length == 3
+        actor, action, object = *args
+      else
+        raise ArgumentError.new("Expected Hash or actor, action, (object)")
+      end
+
+      if actor.respond_to?(:to_dashboard)
+        actor = actor.to_dashboard
+      elsif String === actor
+        actor = { uid: actor }
+      end
+
+      action = action.to_s
+
+      if object.respond_to?(:to_dashboard)
+        object = object.to_dashboard
+      elsif String === object
+        object = { content: object }
+      end
+
+      
+      params = { actor: actor, action: action, object: object, timestamp: timestamp }
+      json = MultiJson.encode(params)
+      puts json
+      if socket = @socket
+        socket.sendmsg_nonblock "POST /v1/activity?api_key=#{@api_key} HTTP/1.1\r\nHost: #{@host}\r\nConnection: keep-alive\r\nContent-Type: application/json\r\nContent-Length: #{json.length}\r\n\r\n#{json}", 0
+        socket.recv_nonblock 512 rescue nil
+      else
+        Thread.new do
+          @mutex.synchronize do
+            @socket ||= TCPSocket.open(@host, @port || 80)
+          end
+          log params
+        end
+      end
+    rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ETIMEDOUT
+      close
+      retry
+    rescue Errno::ECONNREFUSED, Errno::ENETUNREACH
+      # No @socket so we'll try to connect next time
+    end
+
+
+    # Records that a user has been active in the app.
+    def active(uid)
+      push uid, "active"
+    end
+
+    # Records that a new user account has been created (associate them with
+    # cohort).
+    def created(uid)
+      push uid, "created"
+    end
+
+    # Close connection. If you like crossing your t's you can call this when the
+    # app shutsdown.
+    def close
+      @mutex.synchronize do
+        socket, @socket = @socket, nil
+        socket.close if socket
+      end
+    rescue Exception
+    end
+
+    # Push update for the specified user ID and event. Or you can use
+    # active/created.
+    def push(uid, event)
+      return unless @api_key
+      if socket = @socket
+        socket.sendmsg_nonblock "POST /v1/push?api_key=#{@api_key}&uid=#{uid}&event=#{event} HTTP/1.1\r\nHost: #{@host}\r\nConnection: keep-alive\r\nContent-Length: 0\r\n\r\n", 0
+        socket.recv_nonblock 512 rescue nil
+      else
+        Thread.new do
+          @mutex.synchronize do
+            @socket ||= TCPSocket.open(@host, @port || 80)
+          end
+          push uid, event
+        end
+      end
+    rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ETIMEDOUT
+      close
+      retry
+    rescue Errno::ECONNREFUSED, Errno::ENETUNREACH
+      # No @socket so we'll try to connect next time
+    end
+  end
+
+  # Default host name.
+  self.host = "beta.dash-fu.com"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dash-fu
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-22 00:00:00.000000000Z
-dependencies: []
+date: 2011-10-03 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70176105576660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70176105576660
 description: ''
 email: assaf@labnotes.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/dash-fu.rb
-- test/test.rb
+- lib/dash_fu.rb
 - CHANGELOG
 - VERSION
 - README.md
@@ -55,9 +65,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 780141375345856102
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Use me to push data to Dash-fu in real time

data/lib/dash-fu.rb

@@ -1,94 +0,0 @@
-require "socket"
-
-
-# Use me to push data to Dash-fu in real time.
-#
-#
-# The only configuration you need is setting the API key in
-# config/environments/production.rb:
-#
-#   DashFu.api_key = "<your API key>"
-#
-# You only want to push data in production, so make sure the API key is only set
-# in production environment.  Calls to created/active with no API key are
-# simply ignored.
-#
-#
-# You can send events by calling DashFu.push with UID and event, or using the
-# specialized created and active methods.
-#
-# For example, to assign a user to a cohort, we're going to notify Dash-fu
-# whenever an acount gets created:
-#
-#   class User < ActiveRecord::Model
-#     after_create do
-#       DashFu.created id
-#     end
-#   end
-#
-# In this example, we consider a user active whenever they post a status update,
-# and notify Dash-fu accordingly:
-#
-#   class StatusUpdate < ActiveRecord::Model
-#     after_create do
-#       DashFu.active id
-#     end
-#   end
-module DashFu
-  @mutex = Mutex.new
-
-  class << self
-    # DashFu.host is set by default, this is only useful for testing.
-    attr_accessor :host, :port
-
-    # Set the API key with:
-    #   DashFu.api_key = "<your API key>"
-    attr_accessor :api_key
-
-    # Records that a user has been active in the app.
-    def active(uid)
-      push uid, "active"
-    end
-
-    # Records that a new user account has been created (associate them with
-    # cohort).
-    def created(uid)
-      push uid, "created"
-    end
-
-    # Close connection. If you like crossing your t's you can call this when the
-    # app shutsdown.
-    def close
-      @mutex.synchronize do
-        socket, @socket = @socket, nil
-        socket.close if socket
-      end
-    rescue Exception
-    end
-
-    # Push update for the specified user ID and event. Or you can use
-    # active/created.
-    def push(uid, event)
-      return unless @api_key
-      if socket = @socket
-        socket.sendmsg_nonblock "POST /v1/push?api_key=#{@api_key}&uid=#{uid}&event=#{event} HTTP/1.1\r\nHost: #{@host}\r\nConnection: keep-alive\r\nContent-Length: 0\r\n\r\n", 0
-        socket.recv_nonblock 512 rescue nil
-      else
-        Thread.new do
-          @mutex.synchronize do
-            @socket ||= TCPSocket.open(@host, @port || 80)
-          end
-          push uid, event
-        end
-      end
-    rescue Errno::EPIPE, Errno::ECONNRESET, Errno::ETIMEDOUT
-      close
-      retry
-    rescue Errno::ECONNREFUSED, Errno::ENETUNREACH
-      # No @socket so we'll try to connect next time
-    end
-  end
-
-  # Default host name.
-  self.host = "beta.dash-fu.com"
-end

data/test/test.rb

@@ -1,62 +0,0 @@
-require "test/unit"
-require "thread"
-require "cgi"
-require "webrick"
-$: << File.dirname(__FILE__) + "/../lib"
-$: << File.expand_path(File.dirname(__FILE__) + "/..")
-require "dash-fu"
-
-
-$ready = Queue.new
-$server = WEBrick::HTTPServer.new(:Port=>3001, :StartCallback=>lambda { puts "go"; $ready << "go" }, :Logger=>WEBrick::Log.new(nil, WEBrick::Log::FATAL))
-servlet = lambda do |request, response|
-  $request = request
-  response.status = 200
-end
-$server.mount "/v1/push", WEBrick::HTTPServlet::ProcHandler.new(servlet)
-trap "INT" do
-  $server.shutdown
-end
-DashFu.host = "localhost"
-DashFu.port = 3001
-
-
-class Test::Unit::TestCase
-
-end
-
-
-# Test sending live data.
-class LiveTest < Test::Unit::TestCase
-  def setup
-    DashFu.api_key = "foobar"
-    Thread.new { $server.start }
-    $ready.pop
-    $request = nil
-  end
-
-  def test_active_request
-    DashFu.active "56789"
-    sleep 0.2
-    assert_equal "/v1/push", $request.path
-    assert_equal "POST", $request.request_method
-    assert $request.keep_alive?
-  end
-
-  def test_active_data
-    DashFu.active "56789"
-    sleep 0.2
-    query = CGI.parse($request.query_string)
-    assert_equal ["foobar"], query["api_key"]
-    assert_equal ["active"], query["event"]
-    assert_equal ["56789"], query["uid"]
-  end
-
-  def teardown
-    $server.shutdown
-  end
-end
-
-# Test Dashfu API when no API key set (e.g. test and development environments).
-class InactiveTest < Test::Unit::TestCase
-end