dash-fu 1.0.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+1.0.0 on 2011-08-19
+
+First release

data/README.md

@@ -0,0 +1,36 @@
+Use me to push data to [Dash-fu](http://dash-fu.com) in real time.
+
+
+The only configuration you need is setting the API key in
+`config/environments/production.rb`:
+
+    DashFu.api_key = "<your API key>"
+
+Your API key is available from [account settings](http://dash-fu.com/settings).
+
+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
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/dash-fu.gemspec

@@ -0,0 +1,17 @@
+$: << File.dirname(__FILE__) + "/lib"
+
+Gem::Specification.new do |spec|
+  spec.name           = "dash-fu"
+  spec.version        = IO.read("VERSION")
+  spec.author         = "Assaf Arkin"
+  spec.email          = "assaf@labnotes.org"
+  spec.homepage       = "http://dash-fu.com"
+  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.files          = Dir["{bin,lib,test}/**/*", "CHANGELOG", "VERSION", "README.md", "*.gemspec"]
+
+  spec.required_ruby_version = '>= 1.8.7'
+end

data/lib/dash-fu.rb

@@ -0,0 +1,94 @@
+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

@@ -0,0 +1,62 @@
+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

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: dash-fu
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Assaf Arkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-22 00:00:00.000000000Z
+dependencies: []
+description: ''
+email: assaf@labnotes.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dash-fu.rb
+- test/test.rb
+- CHANGELOG
+- VERSION
+- README.md
+- dash-fu.gemspec
+homepage: http://dash-fu.com
+licenses:
+- Public domain
+post_install_message: ! "Use me to push data to [Dash-fu](http://dash-fu.com) in real
+  time.\n\n\nThe only configuration you need is setting the API key in\n`config/environments/production.rb`:\n\n
+  \   DashFu.api_key = \"<your API key>\"\n\nYour API key is available from [account
+  settings](http://dash-fu.com/settings).\n\nYou only want to push data in production,
+  so make sure the API key is only set\nin production environment.  Calls to created/active
+  with no API key are\nsimply ignored.\n\n\nYou can send events by calling DashFu.push
+  with UID and event, or using the\nspecialized created and active methods.\n\nFor
+  example, to assign a user to a cohort, we're going to notify Dash-fu\nwhenever an
+  acount gets created:\n\n    class User < ActiveRecord::Model\n      after_create
+  do\n        DashFu.created id\n      end\n    end\n\nIn this example, we consider
+  a user active whenever they post a status update,\nand notify Dash-fu accordingly:\n\n
+  \   class StatusUpdate < ActiveRecord::Model\n      after_create do\n        DashFu.active
+  id\n      end\n    end\n\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Use me to push data to Dash-fu in real time
+test_files: []