heap-ruby

KO | EN

gitlite — search

#javascript #hacktoberfest #react #go #golang #android #rust #linux #docker #awesome #kubernetes #vue #pytorch #open-source

(★ 16)

Heap server-side API client for Ruby

heap-ruby Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

_This module is deprecated._

# (DEPRECATED) Heap Server-Side API Client for Ruby

[![Build Status](https://travis-ci.org/heap/heap-ruby.svg?branch=master)](https://travis-ci.org/heap/heap-ruby)
[![Coverage Status](https://coveralls.io/repos/github/heap/heap-ruby/badge.svg?branch=master)](https://coveralls.io/github/heap/heap-ruby?branch=master)
[![Dependency Status](https://gemnasium.com/heap/heap-ruby.svg)](https://gemnasium.com/heap/heap-ruby)
[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/heap/heap-ruby/master/frames)
[![Gem Version](https://badge.fury.io/rb/heap.svg)](https://badge.fury.io/rb/heap)

This is a [Ruby](https://www.ruby-lang.org/) client for the
[Heap](https://heapanalytics.com/)
[server-side API](https://heapanalytics.com/docs/server-side).

## Notice

This client is deprecated and this repo is no longer maintained or supported.

## Prerequisites

This gem is tested on [MRI](https://www.ruby-lang.org/en/downloads/) 1.8.7 and
above, and on [JRuby](http://jruby.org/) 1.7 and above.

## Installation

If you're using [bundler](http://bundler.io/), add the following line to your
[Gemfile](http://bundler.io/v1.11/gemfile.html).

```ruby
gem 'heap', '~> 1.0'
```

Otherwise, install the [heap](https://rubygems.org/gems/heap) gem and activate
it in your code manually.

```bash
gem install heap
```

```ruby
require 'heap'
```

## Setup

Place the following code in a file that executes when your application
initializes.

```ruby
Heap.app_id = 'YOUR_APP_ID'
```

In a Ruby on Rails application, place the following snippet in an initializer,
such as `config/initializers/heap.rb`.

```ruby
if Rails.env.production?
  Heap.app_id = 'YOUR_APP_ID'
else
  Heap.app_id = 'YOUR_DEV_APP_ID'
end
```

In some testing environments, connecting to outside servers is undesirable. Set
the `stubbed` accessor to `true` to have all API calls succeed without
generating any network traffic.

```ruby
class StubbedHeapTest < MiniTest::Test
  def setup
    Heap.stubbed = true
  end

def teardown
    Heap.stubbed = false
  end

...
end
```

## Usage

[Track](https://heapanalytics.com/docs/server-side#track) a server-side event.
The properties are optional.

```ruby
Heap.track 'event-name', 'user-identity', property: 'value'
```

[Add properties](https://heapanalytics.com/docs/server-side#add-user-properties)
to a user.

```ruby
Heap.add_user_properties 'user-identity', plan: 'premium1'
```

If the global API client instance stored in `Heap` is not a good fit for your
application's architecture, create your own client instances.

```ruby
heap_client = Heap.new app_id: 'YOUR_APP_ID'
heap_client.track 'event-name', 'user-identity', property: 'value'
```

## Development

After cloning the repository, install the required gems.

```bash
bundle install
```

Make sure the tests pass after making a change.

```bash
rake test
```

If you submit a
[pull request](https://help.github.com/articles/using-pull-requests/),
[Travis CI](https://travis-ci.org/) will run the test suite against your code
on the Ruby VMs that we support. Please fix any errors that it reports.

## Legacy Gem Releases

Gem versions below 1.0 come from
[this repository](https://github.com/HectorMalot/heap), which is an entirely
different codebase. We are very grateful to
[@HectorMalot](https://github.com/HectorMalot) for donating the `heap` gem name
to us.

If you are using a pre-1.0 gem, please consider upgrading to an officially
supported release. In the meantime, you can pin the old version in your
`Gemfile`.

```ruby
gem 'heap', '~> 0.3'
```

heap-ruby

heap-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

heap-ruby

heap-ruby Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README