candies 0.0.2 → 0.0.3

data/README.md

@@ -1,36 +1,6 @@
-# Candies[![travis-ci](https://secure.travis-ci.org/martinciu/candies.png?branch=master)](http://travis-ci.org/martinciu/candies)
-Invisible image based tracing service with Redis backend
-
-## Requirements
-
-Candies uses redis as a datastore.
-
-Candies only supports redis 2.0 or greater.
-
-If you're on OS X, Homebrew is the simplest way to install Redis:
-
-    $ brew install redis
-    $ redis-server /usr/local/etc/redis.conf
-
-You now have a Redis daemon running on 6379.
-
-## Setup
-
-If you are using bundler add candies to your Gemfile:
-
-    gem 'candies'
-
-Then run:
-
-    bundle install
-
-Otherwise install the gem:
-
-    gem install candies
-
-and require it in your project:
-
-    require 'candies'
+# Candies
+[![travis-ci](https://secure.travis-ci.org/martinciu/candies.png?branch=master)](http://travis-ci.org/martinciu/candies)
+####Invisible image based tracing service with Redis backend
 
 ## Usage
 
@@ -59,11 +29,11 @@ It will be available under `http://yourapproot.tld/candies` url
 
 When you have Candies server deployed you can add tracking payload by including `img` tag in your HTML code:
 
-    <a href="http://candies.tld/anyfile.gif?id=tracing-id&foo=bar&baz=foo" />
+    <a href="http://candies.tld/trackername.gif?id=tracing-id&foo=bar&baz=foo" />
 
 or if you mounted candies in your rails app as `candies` then it will be:
 
-    <a href="http://yourapproot.tld/candies/anyfile.gif?id=tracing-id&foo=bar&baz=foo" />
+    <a href="http://yourapproot.tld/candies/trackername.gif?id=tracing-id&foo=bar&baz=foo" />
 
 Also in rails app you can use `candies_image_tag` helper. To do so you have to set `Candies.url` to point to the candies service url. The best way is to put in `config/initializers/candies.rb` file:
     
@@ -71,9 +41,70 @@ Also in rails app you can use `candies_image_tag` helper. To do so you have to s
 
 Now you can use `candies_image_tag` helper in controller views and in mailer views. Example:
 
-    <%= candies_image_tag(:id => "anyone@example.com", :email_type => "hello") %>
+    <%= candies_image_tag(:id => "anyone@example.com", :tracker => "t", :email_type => "hello") %>
+
+Note that `id` parameter is required. If `tracker` parameter is ommited it will be set "t" as default. Rest of parameters is a tracking payload. In this case redis key will be: `candies:tracker:anyone@example.com:2011-11-10T13:13:09+01:00` and value: `"{\"email_type\":\"hello\"}"`. If you don't specify `id` parameter not value will be stored. Invisible image will by served anyway.
+
+## Results
+
+There isn't any dashboard for displaying values. You can review gathered metrics in three ways:
+
+### JSON
+
+You can get all data from candies server if you request it using JSON.
+
+    curl http://localhost:9393/tracker.json?id=10 |jsonpretty
+    {
+      "tracker:10:2011-11-19T22:39:34+01:00": "{\"foo\":\"99\"}",
+      "tracker:10:2011-11-19T22:23:09+01:00": "{\"foo\":\"39\"}",
+      "tracker:10:2011-11-19T22:24:26+01:00": "{\"foo\":\"94\"}"
+    }
+
+Note: `id` parameter is optional.
 
-Note that `id` parameter is required. It will be used to create a redis key under which paload will be stored. In this case redis key will be: `candies:anyone@example.com:2011-11-10T13:13:09+01:00` and value: `"{\"email_type\":\"hello\"}"`. If you don't specify `id` parameter not value will be stored. Invisible image will by served anyway.
+### redis-cli
+
+Just log to your Redis using redis command line interface. Keys started with `candies` so to display all keys from candies type
+
+    redis 127.0.0.1:6379> keys candies*
+    1) "candies:tracker:10:2011-11-19T22:39:34+01:00"
+    2) "candies:tracker:10:2011-11-19T22:23:09+01:00"
+    3) "candies:tracker:10:2011-11-19T22:24:26+01:00"
+
+### redisplay
+
+Use [redisplay](https://github.com/martinciu/redisplay) Simple Rack app for browsing Redis
+
+## Requirements
+
+Candies uses redis as a datastore.
+
+Candies only supports redis 2.0 or greater.
+
+If you're on OS X, Homebrew is the simplest way to install Redis:
+
+    $ brew install redis
+    $ redis-server /usr/local/etc/redis.conf
+
+You now have a Redis daemon running on 6379.
+
+## Setup
+
+If you are using bundler add candies to your Gemfile:
+
+    gem 'candies'
+
+Then run:
+
+    bundle install
+
+Otherwise install the gem:
+
+    gem install candies
+
+and require it in your project:
+
+    require 'candies'
 
 ## Configuration
 
@@ -127,10 +158,6 @@ Simply use the `Candies.redis.namespace` accessor:
 We recommend sticking this in your initializer somewhere after Redis
 is configured.
 
-## Results
-
-There isn't any dashboard for displaying values (yet). You cen review them by logging into `redis-cli`. Sorry.
-
 ## Development
 
 Source hosted at [GitHub](http://github.com/martinciu/candies).

data/lib/candies/helper.rb

@@ -1,7 +1,7 @@
 module Candies
   module Helper
     def candies_image_tag(args)
-      image_tag("#{Candies.url}/t.gif?#{args.to_query}", :alt => "", :width => 1, :height => 1) if Candies.url
+      image_tag("#{Candies.url}/#{args.fetch(:tracker) {|t| "t"}}.gif?#{args.to_query}", :alt => "", :width => 1, :height => 1) if Candies.url
     end
   end
 end

data/lib/candies/server.rb

@@ -1,26 +1,14 @@
-module Candies
-  class Server
-    def call(env)
-      req = Rack::Request.new(env)
-      id = req.params.delete("id")
-      Candies.redis.set([id, Time.now.iso8601].join(":"), req.params.to_json) if !id.nil?
-      [200, headers, [image]]
-    end
-
-    private
-      def headers
-        {
-          "Content-Type"   => "image/gif", 
-          "Content-Length" => "35", 
-          "Cache-Control"  => "no-store, no-cache, must-revalidate, private",
-          "Pragma"         => "no-cache",
-          "Expires"        => "Sat, 25 Nov 2000 05:00:00 GMT"
-        }
-      end
+require "candies/server/base"
+require "candies/server/json"
+require "candies/server/gif"
 
-      def image
-        "GIF89a\u0001\u0000\u0001\u0000\x80\xFF\u0000\xFF\xFF\xFF\u0000\u0000\u0000,\u0000\u0000\u0000\u0000\u0001\u0000\u0001\u0000\u0000\u0002\u0002D\u0001\u0000;"
+module Candies
+  module Server
+    def self.new
+      Rack::Builder.new do
+        use Rack::ContentLength
+        run Candies::Server::Base.new(:gif => Candies::Server::Gif.new, :json => Candies::Server::Json.new)
       end
-  
+    end
   end
 end

data/lib/candies/server/base.rb

@@ -0,0 +1,34 @@
+module Candies
+  module Server
+    class Base
+      attr_accessor :request, :id, :responders
+
+      def initialize(responders = {})
+        @responders = responders
+      end
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        @responders.fetch(format) {@responders[:json]}.call(env)
+      end
+
+      protected
+        def format
+          @request.path.split(".").last.to_sym
+        end
+
+        def tracker
+          @request.path.match(/^\/(\w+)\.?(\w+$)?/)[1]
+        end
+
+        def id
+          @id ||= @request.params.delete("id")        
+        end
+
+        def status
+          200
+        end
+
+    end  
+  end
+end

data/lib/candies/server/gif.rb

@@ -0,0 +1,30 @@
+module Candies
+  module Server
+    class Gif < Base
+
+      def call(env)
+        @request = Rack::Request.new(env)
+        Candies.redis.set(key, @request.params.to_json) if !id.nil?
+        [status, headers, body]
+      end
+
+      protected
+        def headers
+          {
+            "Content-Type"   => "image/gif", 
+            "Cache-Control"  => "no-store, no-cache, must-revalidate, private",
+            "Pragma"         => "no-cache",
+            "Expires"        => "Sat, 25 Nov 2000 05:00:00 GMT"
+          }
+        end
+
+        def body
+          ["GIF89a\u0001\u0000\u0001\u0000\x80\xFF\u0000\xFF\xFF\xFF\u0000\u0000\u0000,\u0000\u0000\u0000\u0000\u0001\u0000\u0001\u0000\u0000\u0002\u0002D\u0001\u0000;"]
+        end
+
+        def key
+          [tracker, id, Time.now.iso8601].join(":")
+        end
+    end  
+  end
+end

data/lib/candies/server/json.rb

@@ -0,0 +1,26 @@
+module Candies
+  module Server
+    class Json < Base
+      
+      def call(env)
+        @request = Rack::Request.new(env)
+        [status, headers, body]
+      end
+
+      protected
+        def headers
+          {
+            "Content-Type" => "application/json" 
+          }
+        end
+
+        def key
+          "#{[tracker, id].compact.join(":")}*"
+        end
+
+        def body
+          [Candies.redis.keys(key).inject({}) {|body, k| body[k] = Candies.redis.get(k);body }.to_json]
+        end
+    end  
+  end
+end

data/lib/candies/version.rb

@@ -1,3 +1,3 @@
 module Candies
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/candies/helper_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Candies::Helper do
+
+  class View
+    include Candies::Helper
+  end
+  
+  Candies.url = "http://example.com"
+
+  before do
+    @view = View.new
+    @args = mock()
+    @args.stubs(:to_query).returns("a=10&c=foo")
+  end 
+  
+  describe "#candies_image_tag" do
+    it "call image_tag with tracker param" do
+      @args.expects(:fetch).with(:tracker).returns("custom")
+      @view.expects(:image_tag).with("http://example.com/custom.gif?a=10&c=foo", :alt => "", :width => 1, :height => 1)
+      @view.candies_image_tag(@args)
+    end
+
+  end
+end

data/spec/candies/{server_spec.rb → server/gif_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Candies::Server do
+describe Candies::Server::Gif do
   include Rack::Test::Methods
 
   before do
@@ -19,7 +19,7 @@ describe Candies::Server do
   it "get /t.gif?id=info@example.com&foo=bar adds record" do
     now = Time.now
     Timecop.freeze(now)
-    @redis.expects(:set).with(["info@example.com", now.iso8601].join(":"), {:foo => "bar"}.to_json)
+    @redis.expects(:set).with(["t", "info@example.com", now.iso8601].join(":"), {:foo => "bar"}.to_json)
     get '/t.gif?id=info@example.com&foo=bar'
     last_response.status.must_equal 200
     last_response['Content-Type'].must_equal 'image/gif'
@@ -37,8 +37,8 @@ describe Candies::Server do
   it "get /t.gif?id=info@example.com adds record with empty payload" do
     now = Time.now
     Timecop.freeze(now)
-    @redis.expects(:set).with(["info@example.com", now.iso8601].join(":"), {}.to_json)
-    get '/t.gif?id=info@example.com'
+    @redis.expects(:set).with(["tracker", "info@example.com", now.iso8601].join(":"), {}.to_json)
+    get '/tracker.gif?id=info@example.com'
     last_response.status.must_equal 200
     last_response['Content-Type'].must_equal 'image/gif'
   end

data/spec/candies/server/json_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Candies::Server do
+  include Rack::Test::Methods
+
+  before do
+    @redis = mock()
+    Candies.stubs(:redis).returns(@redis)
+  end
+
+  def app
+    @app ||= Candies::Server.new
+  end
+
+  it "get /t.json returns all records for t metric" do
+    values = [:foo, :bar]
+    @redis.expects(:get).with(:foo).returns("baz")
+    @redis.expects(:get).with(:bar).returns("foo")
+
+    @redis.expects(:keys).with("t*").returns(values)
+    get '/t.json'
+    last_response.status.must_equal 200
+    last_response['Content-Type'].must_equal 'application/json'
+  end
+
+  it "get /t.gif?&id=foo returns records for id=foo" do
+    values = [:foo, :bar]
+    @redis.expects(:get).with(:foo).returns("baz")
+    @redis.expects(:get).with(:bar).returns("foo")
+
+    @redis.expects(:keys).with("t:foo*").returns(values)
+    get '/t.json?&id=foo'
+    last_response.status.must_equal 200
+    last_response['Content-Type'].must_equal 'application/json'
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: candies
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-10 00:00:00.000000000 Z
+date: 2011-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70237840036260 !ruby/object:Gem::Requirement
+  requirement: &70267951013440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70237840036260
+  version_requirements: *70267951013440
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70237840035400 !ruby/object:Gem::Requirement
+  requirement: &70267951012480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 2.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *70237840035400
+  version_requirements: *70267951012480
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70237840034480 !ruby/object:Gem::Requirement
+  requirement: &70267951011580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70237840034480
+  version_requirements: *70267951011580
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70237840032740 !ruby/object:Gem::Requirement
+  requirement: &70267951010600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70237840032740
+  version_requirements: *70267951010600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70237840047340 !ruby/object:Gem::Requirement
+  requirement: &70267951009620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70237840047340
+  version_requirements: *70267951009620
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70237840045180 !ruby/object:Gem::Requirement
+  requirement: &70267951008760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70237840045180
+  version_requirements: *70267951008760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70237840042840 !ruby/object:Gem::Requirement
+  requirement: &70267951007680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-  version_requirements: *70237840042840
+  version_requirements: *70267951007680
 - !ruby/object:Gem::Dependency
   name: turn
-  requirement: &70237840039340 !ruby/object:Gem::Requirement
+  requirement: &70267951023220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 0.8.3
   type: :development
   prerelease: false
-  version_requirements: *70237840039340
+  version_requirements: *70267951023220
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70237840054200 !ruby/object:Gem::Requirement
+  requirement: &70267951022460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.10.0
   type: :development
   prerelease: false
-  version_requirements: *70237840054200
+  version_requirements: *70267951022460
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70237840052480 !ruby/object:Gem::Requirement
+  requirement: &70267951021760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,7 +120,7 @@ dependencies:
         version: 0.3.5
   type: :development
   prerelease: false
-  version_requirements: *70237840052480
+  version_requirements: *70267951021760
 description: Invisible image based tracing service with Redis backend
 email:
 - marcin.ciunelis@gmail.com
@@ -139,8 +139,13 @@ files:
 - lib/candies.rb
 - lib/candies/helper.rb
 - lib/candies/server.rb
+- lib/candies/server/base.rb
+- lib/candies/server/gif.rb
+- lib/candies/server/json.rb
 - lib/candies/version.rb
-- spec/candies/server_spec.rb
+- spec/candies/helper_spec.rb
+- spec/candies/server/gif_spec.rb
+- spec/candies/server/json_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -156,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4015693725382346057
+      hash: -2058818266629124407
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4015693725382346057
+      hash: -2058818266629124407
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -173,5 +178,7 @@ signing_key:
 specification_version: 3
 summary: ''
 test_files:
-- spec/candies/server_spec.rb
+- spec/candies/helper_spec.rb
+- spec/candies/server/gif_spec.rb
+- spec/candies/server/json_spec.rb
 - spec/spec_helper.rb