candies 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in candies.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Marcin Ciunelis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,153 @@
+# 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'
+
+## Usage
+
+### Standalone service
+
+Candies can be deployed as a standalone service (for example to heroku). To do it create a simple `config.ru` file:
+
+    require 'rubygems'
+    require 'candies'
+
+    # Candies.redis = ENV['REDISTOGO_URL'], read below about redis configuration
+
+    run Candies::Server.new
+
+and deploy it to any `rack` compatybile environment (passenger, thin, unicorn, etc.)
+
+### Mounted to the Rails app
+
+Mount Candies in your `config/routes.rb` file:
+
+    mount Candies::Server.new => "candies", :as => "candies"
+
+It will be available under `http://yourapproot.tld/candies` url
+
+### Image tag
+
+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" />
+
+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" />
+
+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:
+    
+    Candies.host = "http://yourapproot.tld/candies"
+
+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") %>
+
+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.
+
+## Configuration
+
+### Redis
+
+You may want to change the Redis host and port Candies connects to, or
+set various other options at startup.
+
+Candies has a `redis` setter which can be given a string or a Redis
+object. This means if you're already using Redis in your app, Candies
+can re-use the existing connection.
+
+String: `Candies.redis = 'localhost:6379'`
+
+Redis: `Candies.redis = $redis`
+
+For our rails app we have a `config/initializers/candies.rb` file where
+we load `config/candies.yml` by hand and set the Redis information
+appropriately.
+
+Here's our `config/redis.yml`:
+
+    development: localhost:6379
+    test: localhost:6379
+    staging: redis1.example.com:6379
+    fi: localhost:6379
+    production: redis1.example.com:6379
+
+And our initializer:
+
+    rails_root = ENV['RAILS_ROOT'] || File.dirname(__FILE__) + '/../..'
+    rails_env = ENV['RAILS_ENV'] || 'development'
+
+    redis_config = YAML.load_file(rails_root + '/config/redis.yml')
+    Candies.redis = redis_config[rails_env]
+
+## Namespaces
+
+If you're running multiple, separate instances of candies you may want
+to namespace the keyspaces so they do not overlap. This is not unlike
+the approach taken by many memcached clients.
+
+This feature is provided by the [redis-namespace][rs] library, which
+candies uses by default to separate the keys it manages from other keys
+in your Redis server.
+
+Simply use the `Candies.redis.namespace` accessor:
+
+    Candies.redis.namespace = "candies:blog"
+
+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).
+Report Issues/Feature requests on [GitHub Issues](http://github.com/martinciu/candies/issues).
+
+Tests can be ran with `rake test`
+
+### Note on Patches/Pull Requests
+
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history.
+   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Marcin Ciunelis. See [LICENSE](https://github.com/martinciu/candies/blob/master/LICENSE) for details.

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+Bundler.setup(:default, :test)
+
+Rake::TestTask.new do |t|
+  t.libs << "spec"
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/candies.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/candies/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marcin Ciunelis"]
+  gem.email         = ["marcin.ciunelis@gmail.com"]
+  gem.description   = %q{Invisible image based tracing service with Redis backend}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "candies"
+  gem.require_paths = ["lib"]
+  gem.version       = Candies::VERSION
+
+  gem.add_dependency "rack", "~> 1.3.4"
+  gem.add_dependency 'redis', '~> 2.2.2'
+  gem.add_dependency 'redis-namespace', '>= 1.0.3'
+  gem.add_dependency "json", ">= 1.5.3"
+
+  gem.add_development_dependency "rake", "~> 0.9.2"
+  gem.add_development_dependency "minitest", "~> 2.7.0"
+  gem.add_development_dependency "rack-test", "~> 0.6"
+  gem.add_development_dependency "turn", "~> 0.8.3"
+  gem.add_development_dependency "mocha", "~> 0.10.0"
+  gem.add_development_dependency 'timecop', '~> 0.3.5'
+
+end

data/example/config.ru

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
+
+require 'candies'
+
+# Candies.redis = ENV['REDISTOGO_URL']
+
+run Candies::Server.new

data/lib/candies.rb

@@ -0,0 +1,70 @@
+require 'redis/namespace'
+require 'time'
+require 'json'
+
+require "candies/server"
+require "candies/helper"
+
+module Candies
+  extend self
+
+  attr_accessor :url
+
+  # Accepts:
+  #   1. A 'hostname:port' String
+  #   2. A 'hostname:port:db' String (to select the Redis db)
+  #   3. A 'hostname:port/namespace' String (to set the Redis namespace)
+  #   4. A Redis URL String 'redis://host:port'
+  #   5. An instance of `Redis`, `Redis::Client`, `Redis::DistRedis`,
+  #      or `Redis::Namespace`.
+  def redis=(server)
+    case server
+    when String
+      if server =~ /redis\:\/\//
+        redis = Redis.connect(:url => server, :thread_safe => true)
+      else
+        server, namespace = server.split('/', 2)
+        host, port, db = server.split(':')
+        redis = Redis.new(:host => host, :port => port,
+          :thread_safe => true, :db => db)
+      end
+      namespace ||= :candies
+
+      @redis = Redis::Namespace.new(namespace, :redis => redis)
+    when Redis::Namespace
+      @redis = server
+    else
+      @redis = Redis::Namespace.new(:candies, :redis => server)
+    end
+  end
+
+  # Returns the current Redis connection. If none has been created, will
+  # create a new one.
+  def redis
+    return @redis if @redis
+    self.redis = Redis.respond_to?(:connect) ? Redis.connect : "localhost:6379"
+    self.redis
+  end
+
+  def redis_id
+    # support 1.x versions of redis-rb
+    if redis.respond_to?(:server)
+      redis.server
+    else
+      redis.client.id
+    end
+  end
+
+end
+
+if defined?(Rails)
+  class ActionController::Base
+    ActionController::Base.send :include, Candies::Helper
+    ActionController::Base.helper Candies::Helper
+  end
+  class ActionMailer::Base
+    ActionMailer::Base.send :include, Candies::Helper
+    ActionMailer::Base.helper Candies::Helper
+  end
+end
+

data/lib/candies/helper.rb

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

data/lib/candies/server.rb

@@ -0,0 +1,26 @@
+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
+
+      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;"
+      end
+  
+  end
+end

data/lib/candies/version.rb

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

data/spec/candies/server_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Candies::Server do
+  include Rack::Test::Methods
+
+  before do
+    @redis = mock()
+    Candies.stubs(:redis).returns(@redis)
+  end
+
+  after(:each) do
+    Timecop.return
+  end
+
+  def app
+    @app ||= Candies::Server.new
+  end
+
+  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)
+    get '/t.gif?id=info@example.com&foo=bar'
+    last_response.status.must_equal 200
+    last_response['Content-Type'].must_equal 'image/gif'
+  end
+
+  it "get /t.gif?&foo=bar is ignored" do
+    now = Time.now
+    Timecop.freeze(now)
+    @redis.expects(:set).never
+    get '/t.gif?&foo=bar'
+    last_response.status.must_equal 200
+    last_response['Content-Type'].must_equal 'image/gif'
+  end
+
+  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'
+    last_response.status.must_equal 200
+    last_response['Content-Type'].must_equal 'image/gif'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'turn'
+require 'mocha'
+require 'rack/test'
+require 'timecop'
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+$TESTING = true
+

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: candies
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Marcin Ciunelis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70237840036260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237840036260
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70237840035400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237840035400
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: &70237840034480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237840034480
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70237840032740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *70237840032740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70237840047340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70237840047340
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70237840045180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70237840045180
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70237840042840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70237840042840
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: &70237840039340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *70237840039340
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70237840054200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70237840054200
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: &70237840052480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.5
+  type: :development
+  prerelease: false
+  version_requirements: *70237840052480
+description: Invisible image based tracing service with Redis backend
+email:
+- marcin.ciunelis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- candies.gemspec
+- example/config.ru
+- lib/candies.rb
+- lib/candies/helper.rb
+- lib/candies/server.rb
+- lib/candies/version.rb
+- spec/candies/server_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4015693725382346057
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4015693725382346057
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/candies/server_spec.rb
+- spec/spec_helper.rb