keen 0.7.7 → 0.7.8

data/README.md

@@ -1,6 +1,6 @@
 # Keen IO Official Ruby Client Library
 
-[![Build Status](https://secure.travis-ci.org/keenlabs/keen-gem.png?branch=master)](http://travis-ci.org/keenlabs/keen-gem)
+[![Build Status](https://secure.travis-ci.org/keenlabs/keen-gem.png?branch=master)](http://travis-ci.org/keenlabs/keen-gem) [![Code Climate](https://codeclimate.com/github/keenlabs/keen-gem.png)](https://codeclimate.com/github/keenlabs/keen-gem)
 
 keen-gem is the official Ruby Client for the [Keen IO](https://keen.io/) API. The
 Keen IO API lets developers build analytics features directly into their apps.
@@ -224,6 +224,17 @@ Keen.beacon_url("sign_ups", :recipient => "foo@foo.com")
 
 To track email opens, simply add an image to your email template that points to this URL.
 
+#### Redirect URL's
+Redirect URL's are just like image beacon URL's with the addition of a `redirect` query parameter. This parameter is used
+to issue a redirect to a certain URL after an event is recorded.
+
+```
+Keen.redirect_url("sign_ups", { :recipient => "foo@foo.com" }, "http://foo.com")
+  # => "https://api.keen.io/3.0/projects/xxxxxx/events/email_opens?api_key=yyyyyy&data=eyJyZWNpcGllbnQiOiJmb29AZm9vLmNvbSJ9&redirect=http://foo.com"
+```
+
+This is helpful for tracking email clickthroughs.
+
 ### Changelog
 
 ##### 0.7.7

data/lib/keen.rb

@@ -38,7 +38,7 @@ module Keen
 
     def_delegators :default_client,
                    :publish, :publish_async, :publish_batch,
-                   :beacon_url
+                   :beacon_url, :redirect_url
 
     def_delegators :default_client,
                    :count, :count_unique, :minimum, :maximum,

data/lib/keen/client/publishing_methods.rb

@@ -113,6 +113,22 @@ module Keen
         "#{self.api_url}#{api_event_collection_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}"
       end
 
+      # Returns an encoded URL that will record an event and then redirect. Useful in email situations.
+      # See detailed documentation here
+      # https://keen.io/docs/api/reference/#event-collection-resource
+      #
+      # @param event_collection
+      # @param [Hash] event properties
+      #
+      # @return a URL that will track an event when hit
+      def redirect_url(event_collection, properties, redirect_url)
+        require 'open-uri'
+        encoded_url = URI::encode(redirect_url)
+        json = MultiJson.encode(properties)
+        data = [json].pack("m0").tr("+/", "-_").gsub("\n", "")
+        "#{self.api_url}#{api_event_collection_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}&redirect=#{encoded_url}"
+      end
+
       private
 
       def publish_body(path, body, error_method)

data/lib/keen/version.rb

@@ -1,3 +1,3 @@
 module Keen
-  VERSION = "0.7.7"
+  VERSION = "0.7.8"
 end

data/spec/keen/client/publishing_methods_spec.rb

@@ -230,4 +230,11 @@ describe Keen::Client::PublishingMethods do
         "#{api_url}/3.0/projects/12345/events/sign_ups?api_key=#{write_key}&data=eyJuYW1lIjoiQm9iIn0="
     end
   end
+
+  describe "redirect_url" do
+    it "should return a url with a base-64 encoded json param and an encoded redirect url" do
+      client.redirect_url("sign_ups", { :name => "Bob" }, "http://keen.io/?foo=bar&bar=baz").should ==
+        "#{api_url}/3.0/projects/12345/events/sign_ups?api_key=#{write_key}&data=eyJuYW1lIjoiQm9iIn0=&redirect=http://keen.io/?foo=bar&bar=baz"
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keen
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-06 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json