lessneglect 0.3.0 → 0.3.1

data/Rakefile

@@ -15,7 +15,7 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "lessneglect"
-  gem.homepage = "http://github.com/cgooley/lessneglect-ruby"
+  gem.homepage = "http://github.com/lessneglect/lessneglect-ruby"
   gem.license = "MIT"
   gem.summary = "LessNeglect client API"
   gem.description = "API library to allow you to connect and submit messages and actions to your LessNeglect project account"

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/lessneglect.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "lessneglect"
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christopher Gooley"]
@@ -13,8 +13,7 @@ Gem::Specification.new do |s|
   s.description = "API library to allow you to connect and submit messages and actions to your LessNeglect project account"
   s.email = "gooley@lessneglect.com"
   s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
+    "LICENSE.txt"
   ]
   s.files = [
     ".document",
@@ -23,7 +22,6 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
     "Rakefile",
     "VERSION",
     "lessneglect.gemspec",
@@ -35,10 +33,11 @@ Gem::Specification.new do |s|
     "lib/lessneglect/objects/event.rb",
     "lib/lessneglect/objects/message.rb",
     "lib/lessneglect/objects/person.rb",
+    "readme.md",
     "spec/lessneglect_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/cgooley/lessneglect-ruby"
+  s.homepage = "http://github.com/lessneglect/lessneglect-ruby"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = "1.8.24"

data/readme.md

@@ -0,0 +1,115 @@
+LessNeglect
+===
+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.
+
+```ruby
+class Neglect
+  
+  def self.api
+    @@api ||= LessNeglectApi::Client.new({
+        :code => "asdfasdf",
+        :secret => "1234asdfasdf1234"
+      })
+  end
+
+  def self.log_event(user, event_name, extras = {})
+    return if user.nil? || user[:impersonating]
+    return if Rails.env == "development"
+    
+    begin
+      person = LessNeglectApi::Person.new({
+          :name => user.name,
+          :email => user.email,
+          :external_identifer => user.id,
+          :properties => {
+            :account_level => user.account_level,
+            :is_paying => user.paying?,
+            :created_at => user.created_at.to_i
+          }
+        })
+
+      event = LessNeglectApi::ActionEvent.new({
+          :name => event_name
+        }.merge(extras))
+
+      api.create_action_event(person, event)
+    rescue
+      puts "error logging to LN"
+    end
+  end
+
+  def self.update_person(user)
+    return if Rails.env == "development"
+    
+    begin
+      person = LessNeglectApi::Person.new({
+          :name => user.name,
+          :email => user.email,
+          :external_identifer => user.id,
+          :properties => {
+            :account_level => user.account_level,
+            :is_paying => user.paying?,
+            :created_at => user.created_at.to_i
+          }
+        })
+
+      api.update_person(person)
+    rescue
+      puts "error logging to LN"
+    end
+  end
+
+end
+```
+
+Helper Usage
+--
+```ruby
+Neglect.log_event(user, "uploaded-media")
+```
+
+== Copyright
+
+Copyright (c) 2011-2012 Christopher Gooley. See LICENSE.txt for further details.
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lessneglect
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -98,7 +98,6 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
 files:
 - .document
 - .rspec
@@ -106,7 +105,6 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
 - Rakefile
 - VERSION
 - lessneglect.gemspec
@@ -118,9 +116,10 @@ files:
 - lib/lessneglect/objects/event.rb
 - lib/lessneglect/objects/message.rb
 - lib/lessneglect/objects/person.rb
+- readme.md
 - spec/lessneglect_spec.rb
 - spec/spec_helper.rb
-homepage: http://github.com/cgooley/lessneglect-ruby
+homepage: http://github.com/lessneglect/lessneglect-ruby
 licenses:
 - MIT
 post_install_message: 

data/README.rdoc

@@ -1,8 +0,0 @@
-= lessneglect
-
-Gem to allow your ruby app to submit messages and actions to your LessNeglect project account.
-
-== Copyright
-
-Copyright (c) 2011-2012 Christopher Gooley. See LICENSE.txt for further details.
-