heap 0.3.0 → 1.0.0

data/test/helper.rb

@@ -1,16 +1,4 @@
-require 'simplecov'
-
-module SimpleCov::Configuration
-  def clean_filters
-    @filters = []
-  end
-end
-
-SimpleCov.configure do
-  clean_filters
-  load_profile 'test_frameworks'
-end
-
+require 'rubygems'
 require 'bundler'
 begin
   Bundler.setup(:default, :development)
@@ -19,12 +7,11 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+require 'minitest/autorun'
 
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'heap'
-require 'heap/view_helpers'
-require 'minitest/autorun'
-require 'shoulda'
-require 'webmock/minitest'
 
 class MiniTest::Test
 end

metadata

@@ -1,141 +1,140 @@
 --- !ruby/object:Gem::Specification
 name: heap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
-- Dennis de Reus
+- Victor Costan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.8.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: 0.8.11
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.8.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.8.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 0.8.7.6
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3.12'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: jeweler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: 2.0.1
   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
+        version: 2.0.1
+description: Implements Heap's server-side API
+email: victor@heapanalytics.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG.mdown
 - LICENSE.txt
-- README.mdown
+- README.md
 files:
 - ".document"
-- CHANGELOG.mdown
+- ".travis.yml"
 - Gemfile
-- Gemfile.lock
+- Gemfile187
 - LICENSE.txt
-- README.mdown
+- README.md
 - Rakefile
 - VERSION
 - heap.gemspec
-- 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
+- lib/heap/client.rb
+- lib/heap/errors.rb
+- lib/heap/validations.rb
+- test/client_add_user_properties_test.rb
+- test/client_test.rb
+- test/client_track_test.rb
+- test/heap_test.rb
 - test/helper.rb
-- test/test_heap.rb
-- test/test_view_helper.rb
-homepage: https://github.com/HectorMalot/heap
+homepage: http://github.com/heap/heap-ruby
 licenses:
 - MIT
 metadata: {}
@@ -155,8 +154,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Easy integration of heapanalytics into your ruby app
+summary: Heap server-side API client
 test_files: []

data/CHANGELOG.mdown

@@ -1,18 +0,0 @@
-# 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/Gemfile.lock

@@ -1,91 +0,0 @@
-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/README.mdown

@@ -1,99 +0,0 @@
-# Heap
-
-[![Gem Version](https://badge.fury.io/rb/heap.svg)](http://badge.fury.io/rb/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? %>
-
-If you wish to use a different handle type, only `handle`/`email` are supported at the time of writing, you can set it using `Heap.default_handle_type = 'handle'`.
-
-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:
-
-* [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)
-
-### Advanced load configuration
-
-When calling 'heap_analytics', you may set additional advanced configuration options (such as secure cookies, enabling SSL, and disabling text capture). The helper takes an optional argument:
-
-* [Hash, optional] properties: A hash containing additional configuration options (Hashes with multiple levels are currently not supported)
-
-Example:
-
-      <%= heap_analytics(forceSSL: true, secureCookie: true, disableTextCapture: true) %>
-
-## 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/lib/generators/heap/install_generator.rb

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