heap 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29e1017542b6783bbcb5bea44b19cba64c422c34
-  data.tar.gz: d082a1e537a141cc57d26cf3d604c95b08ae80ff
+  metadata.gz: d744f1219db0c3007df69dd94f39c0b1850638bc
+  data.tar.gz: 51dbfcc6932734701355ce03ae8e75dbbaa171d6
 SHA512:
-  metadata.gz: 13f9fbb1e5a7c4872f80e89062cbe448efe36c35e7ee463bece34b49b891d9a37990c9bf8c27563d0fc9ebe1757d284b10dac63e8525df08e34415c54b5994a6
-  data.tar.gz: 8c22f073fba35448e2fccf535ea75dd76348550ab3c1308b52f62402a78fa1100f316c2f2d898751dad895d7c8f9f1ec6ef93c31b9ac3e5b97e24b0da3a832c6
+  metadata.gz: 3fee957cce4f2c73d599457071c86a0a1bdc7d71f60cab29768c7390910d9222e51eb4c102284f8e685eee548fa84eb367f5d72f3744fd831302d4eeddf8530f
+  data.tar.gz: a5eb712028103a1143b477d97115e9fb66c759dd2eed4f5fb0cbff5c6fa8f694b78560519e05168eaca5bbab592f1a1e97b7b1763b59cc8ca9ae9702a1254dfd

data/CHANGELOG.mdown

@@ -0,0 +1,18 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+<!-- ## [Unreleased][unreleased] -->
+
+## [0.1.3] - 2015-02-05
+### Changed
+- Updated to new JS snippet from heap
+
+## [0.1.2] - 2014-12-21
+### Added
+- Heap now gives you the option to use another user handle instead of e-mail
+
+[unreleased]: https://github.com/hectormalot/heap/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/hectormalot/heap/compare/v0.1.3...v0.1.2
+[0.1.2]: https://github.com/hectormalot/heap/compare/v0.1.2...v0.1.1
+[0.1.1]: https://github.com/hectormalot/heap/compare/v0.1.1...v0.1.0

data/README.mdown

@@ -30,7 +30,7 @@ Heap needs your application ID to successfully submit data to heapanalytics.com.
 
 ### Identifying your users
 
-The `heap_identify` view helper can be used to supply heap with attributes for your users. The helper takes 2 arguments: 
+The `heap_identify` view helper can be used to supply heap with attributes for your users. The helper takes 2 arguments:
 
 * [String] email: The e-mail address used to identify your visitor in Heap
 * [Hash, optional] properties: A hash containing additional properties for your users (Hashes with multiple levels are currently not supported)
@@ -43,6 +43,12 @@ If you wish to use a different handle type, only `handle`/`email` are supported
 
 Default is set to `email`.
 
+### Adding custom event properties
+
+With `heap_set_event_properties`, you can specify key-value pairs to associate with all of a user's subsequent events. This helper takes one argument:
+
+* [Hash] properties: A hash containing all of the properties you want to attach to the user's events
+
 ### Tracking server-side events
 
 In case you want to track server-side events -- for example when sending a welcome e-mail to a new user --, you can do so using `Heap.event`. `Heap.event` takes 3 arguments:
@@ -55,7 +61,7 @@ Example:
 
     Heap.event("Welcome e-mail sent", "user@example.com", promotion:'second gem free', segment:'ruby developers')
 
-### Adding server-side user attributes 
+### Adding server-side user attributes
 
 To update or set properties on your users directly from your application, use `Heap.identify`. `Heap.identify` takes 2 arguments:
 
@@ -67,7 +73,7 @@ Example:
     Heap.identify("user@example.com", segment:'ruby developers', age: 25)
 
 ## Contributing to Heap
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/heap.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: heap 0.1.3 ruby lib
+# stub: heap 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "heap"
-  s.version = "0.1.3"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Dennis de Reus"]
-  s.date = "2015-02-05"
+  s.date = "2015-04-04"
   s.description = "Easy integration of heapanalytics into your ruby app"
   s.email = "dennisdereus@gmail.com"
   s.extra_rdoc_files = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGELOG.mdown",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/lib/heap/view_helpers.rb

@@ -1,18 +1,26 @@
+require 'json'
+
 class Heap
   module ViewHelpers
     def heap_analytics
-      javascript_tag :type => "text/javascript" do
-        raw %Q{
-          window.heap=window.heap||[],heap.load=function(t,e){window.heap.appid=t,window.heap.config=e;var a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src=("https:"===document.location.protocol?"https:":"http:")+"//cdn.heapanalytics.com/js/heap-"+t+".js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n);for(var o=function(t){return function(){heap.push([t].concat(Array.prototype.slice.call(arguments,0)))}},p=["clearEventProperties","identify","setEventProperties","track","unsetEventProperty"],c=0;c<p.length;c++)heap[p[c]]=o(p[c])};
-          heap.load("#{Heap.app_id}");
-          }.html_safe
-      end
+      heap_js_block %Q{
+        window.heap=window.heap||[],heap.load=function(t,e){window.heap.appid=t,window.heap.config=e;var a=document.createElement("script");a.type="text/javascript",a.async=!0,a.src=("https:"===document.location.protocol?"https:":"http:")+"//cdn.heapanalytics.com/js/heap-"+t+".js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(a,n);for(var o=function(t){return function(){heap.push([t].concat(Array.prototype.slice.call(arguments,0)))}},p=["clearEventProperties","identify","setEventProperties","track","unsetEventProperty"],c=0;c<p.length;c++)heap[p[c]]=o(p[c])};
+        heap.load("#{Heap.app_id}");
+      }
     end
 
     def heap_identify(handle, properties = nil)
       body = properties.map {|k,v| ", #{k}: \"#{v}\""}.join if properties.is_a? Hash
-      javascript_tag do
-        raw %Q{heap.identify({#{Heap.default_handle_type}: "#{handle}" #{body}});}.html_safe
+      heap_js_block %Q{heap.identify({#{Heap.default_handle_type}: "#{handle}" #{body}});}
+    end
+
+    def heap_set_event_properties(properties = {})
+      heap_js_block %Q{heap.setEventProperties(#{properties.to_json});}
+    end
+
+    def heap_js_block(content)
+      javascript_tag :type => "text/javascript" do
+        raw content.html_safe
       end
     end
   end

data/test/test_view_helper.rb

@@ -1,10 +1,34 @@
 require 'helper'
 
+class String
+  def html_safe
+    self
+  end
+end
+
 class HeapHelperTest < MiniTest::Test
   include Heap::ViewHelpers
 
-  should "produce correct identify handle type" #do
-    # handle = '123'
-    # assert_equal heap_identify(handle), "heap.identify({email: \"#{handle}\" });"
-  # end
+  def javascript_tag(options = {})
+    yield
+  end
+
+  def raw(js)
+    js
+  end
+
+  should "produce correct identify handle type" do
+    handle = '123'
+    assert_equal heap_identify(handle), "heap.identify({email: \"#{handle}\" });"
+  end
+
+  should "set event properties from arbitrary key-value pairs" do
+    js = heap_set_event_properties({
+      :first => "first value",
+      "second" => 2,
+      :third => true
+    })
+
+    assert_equal js, %Q/heap.setEventProperties({"first":"first value","second":2,"third":true});/
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: heap
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Dennis de Reus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-05 00:00:00.000000000 Z
+date: 2015-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -117,6 +117,7 @@ extra_rdoc_files:
 - README.mdown
 files:
 - ".document"
+- CHANGELOG.mdown
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt