Sha256: 007a054dc8ae37b0f8ee79bfba1a622e8c82d4b602cc30c60eb3dbf50612062a

Contents?: true

Size: 1.13 KB

Versions: 3

Compression:

Stored size: 1.13 KB

Contents

LessNeglect Ruby Client
===
Allow your Ruby app to easily submit server-side messages and events to LessNeglect.

Installation
---

In your Gemfile:

```ruby
gem 'lessneglect'
```

Usage
---

```ruby
person = LessNeglectApi::Person.new({
    :name => "Christopher Gooley",
    :email => "gooley@foliohd.com",
    :external_identifer => "gooley",
    :properties => {
      :account_level => "Pro",
      :is_paying => True,
      :created_at => 1347060566
    }
  })

event = LessNeglectApi::ActionEvent.new({
    :name => "upgraded"
  }.merge(extras))

api = LessNeglectApi::Client.new({
    :code => "abcdefg",
    :secret => "1234asdfasdf1234"
  })

api.create_action_event(person, event)
```

Sample Helper Class
---

We suggest you create a simple helper class such as /lib/neglect.rb to convert your User model into a LessNeglect Person and submit the event.

Here's a sample gist of what the helper could look like:
https://gist.github.com/3738364

then you can make one-line event logs:
```ruby
Neglect.log_event(@current_user, "uploaded-media")
```

Copyright (c) 2011-2012 Christopher Gooley, Less Neglect. See LICENSE.txt for further details.

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
lessneglect-0.3.5 readme.md
lessneglect-0.3.4 readme.md
lessneglect-0.3.3 readme.md