heap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 330313ec277d5228071e1ba15c111b557ca30f1b
+  data.tar.gz: 82925987e6fc300ed9894ed3f07bed3200a5ec7a
+SHA512:
+  metadata.gz: 8e6b894665ec72fdc535163397898bfb8a80dc892ede8b1d7b879c97d9625cebc38be3954108a2ae9faa9381848fcdd0bce0120d98e474b5c9ea4124ba86a77c
+  data.tar.gz: 5be0df3fe09fa297b7b957f36c958e702490e104c7119b2776c38c7a0c8774f426741edd43ac684329e1373c2e75454a72f89385e6ba76b4752da7cab3f1542c

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+  gem "httparty", "~> 0.13"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem "webmock", "~>1.20"
+end

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.1.8)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    builder (3.2.2)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.8)
+    github_api (0.12.2)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.3)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.3)
+      oauth2
+    hashie (3.3.2)
+    highline (1.6.21)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.11)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.2.0)
+    mini_portile (0.6.1)
+    minitest (5.4.3)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.4.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    safe_yaml (1.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.20.4)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  httparty (~> 0.13)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+  webmock (~> 1.20)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Dennis de Reus
+
+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.mdown

@@ -0,0 +1,78 @@
+# Heap
+
+Heap is a simple rubygem that makes is simple to integrate your application with [heap analytics](heapanalytics.com). It provides:
+
+* Helpers to easily integrate heap into your Rails application
+* An easy way to submit events to heap directly from your code
+* The possibility to set additional attributes on your users directly from your app
+
+## Installation
+
+Installation is simple via:
+
+    gem install heap
+
+For Rails applications, run the following command to add an initiatlizer for your heap `app_id`:
+
+    rails generate heap:install
+
+To enable the tracking code on your website, place the following in just before the closing `</head>` tag in your layout:
+
+    <%= heap_analytics %>
+
+## Usage
+
+After installing, you will have access to `Heap.event` and `Heap.identify` in your ruby code. For Rails, Heap provides 2 helpers to include the tracking code, and to identify individual users.
+
+Heap needs your application ID to successfully submit data to heapanalytics.com. You can set this directly using `Heap.app_id = 123`, or in Rails, by using the provided generator to generate an initializer at config/initializers/heap.rb
+
+### Identifying your users
+
+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)
+
+Example:
+
+    <%= heap_identify(current_user.email, name: current_user.name, role: current_user.role) if signed_in? %>
+
+### 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:
+
+* [String] event: A description of the event
+* [String] identity: The e-mail address used to identify your user
+* [Hash, optional] properties: A hash containing additional properties for the event (Hashes with multiple levels are currently not supported)
+
+Example:
+
+    Heap.event("Welcome e-mail sent", "user@example.com", promotion:'second gem free', segment:'ruby developers')
+
+### 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:
+
+* [String] identity: The e-mail address used to identify your user
+* [Hash] properties: A hash containing additional properties for your users (Hashes with multiple levels are currently not supported)
+
+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.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+The Heap gem is licensed under the MIT license. Copyright (c) 2014 Dennis de Reus. See LICENSE.txt for further details.
+
+The Heap gem is a personal project and not affiliated to heapanalytics.com
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "heap"
+  gem.homepage = "http://github.com/HectorMalot/heap"
+  gem.license = "MIT"
+  gem.summary = %Q{Easy integration of heapanalytics into your ruby app}
+  gem.description = %Q{Easy integration of heapanalytics into your ruby app}
+  gem.email = "dennisdereus@gmail.com"
+  gem.authors = ["Dennis de Reus"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "heap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/generators/heap/install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+class Heap
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      def copy_initializer
+        template "heap.rb", "config/initializers/heap.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/heap.rb

@@ -0,0 +1,2 @@
+# change this to your Heap ID, or use a environment variable to set your ID
+Heap.app_id = ENV["HEAP_ID"]

data/lib/heap.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+require 'heap/events'
+require 'heap/railtie' if defined?(Rails)
+
+class Heap
+  include HTTParty
+  base_uri 'https://heapanalytics.com/api'
+  headers "Content-Type" => "application/json"
+
+  def self.app_id=(obj)
+    @@app_id = obj
+  end
+
+  def self.app_id
+    @@app_id
+  end
+end

data/lib/heap/events.rb

@@ -0,0 +1,22 @@
+class Heap
+  def self.event(event,identity=nil,properties=nil)
+    return unless self.app_id
+    body = { 
+      app_id: self.app_id.to_s,
+      event: event
+    }
+    body[:identity] = identity if identity
+    body[:properties] = properties if properties.is_a? Hash
+    post("/track",body:body.to_json)
+  end
+
+  def self.identify(identity,properties)
+    return unless self.app_id
+    body= {
+      app_id: self.app_id.to_s,
+      identity: identity
+    }
+    body[:properties] = properties if properties.is_a? Hash
+    post("/identify",body:body.to_json)
+  end
+end

data/lib/heap/railtie.rb

@@ -0,0 +1,9 @@
+require 'heap/view_helpers'
+
+class Heap
+  class Railtie < Rails::Railtie
+    initializer "heap.view_helpers" do
+      ActiveSupport.on_load( :action_view ){ include Heap::ViewHelpers }
+    end
+  end
+end

data/lib/heap/view_helpers.rb

@@ -0,0 +1,20 @@
+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.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
+    end
+
+    def heap_identify(email, properties=nil)
+      body = properties.map {|k,v| ", #{k}: \"#{v}\""}.join if properties.is_a? Hash
+      javascript_tag do
+        raw %Q{heap.identify({email: "#{email}" #{body}}); }.html_safe
+      end
+
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,31 @@
+require 'simplecov'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'heap'
+require 'minitest/autorun'
+require 'shoulda'
+require 'webmock/minitest'
+
+class MiniTest::Test
+end
+
+MiniTest.autorun

data/test/test_heap.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestHeap < MiniTest::Test
+  should "post events to https://heapanalytics.com/api/track" do
+    stub_request(:post, "https://heapanalytics.com/api/track").
+      with(:body => {:app_id => '123', :event => 'test', :identity => 'test@example.com', :properties => {:property1 => 'hello', :property2 => 'world'}},
+         :headers => {'Content-Type'=>'application/json'}).
+      to_return(:body => "OK")
+
+    Heap.app_id = 123
+    result = Heap.event('test','test@example.com', :property1 => 'hello', :property2 => 'world')
+    assert_equal result.to_s, "OK"
+  end
+
+  should "post identities to https://heapanalytics.com/api/identify" do
+    stub_request(:post, "https://heapanalytics.com/api/identify").
+      with(:body => {:app_id => '123', :identity => 'test@example.com', :properties => {:property1 => 'hello', :property2 => 'world'}},
+         :headers => {'Content-Type'=>'application/json'}).
+      to_return(:body => "{}")
+
+    Heap.app_id = 123
+    result = Heap.identify('test@example.com', :property1 => 'hello', :property2 => 'world')
+    assert_equal result.to_s, "{}"
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: heap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dennis de Reus
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: Easy integration of heapanalytics into your ruby app
+email: dennisdereus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.mdown
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.mdown
+- Rakefile
+- VERSION
+- lib/generators/heap/install_generator.rb
+- lib/generators/templates/heap.rb
+- lib/heap.rb
+- lib/heap/events.rb
+- lib/heap/railtie.rb
+- lib/heap/view_helpers.rb
+- test/helper.rb
+- test/test_heap.rb
+homepage: http://github.com/HectorMalot/heap
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easy integration of heapanalytics into your ruby app
+test_files: []