devise_keen 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eda9f2d7a8e03e47bb7d23a1d6cabbf4293c803
-  data.tar.gz: bc13378e957a35b7f96a6d91959aceb2c2c4b4f6
+  metadata.gz: fc7f5412356183bc4240f10134d66819dbd9a05b
+  data.tar.gz: f8ce805c136ce5c269e111134f25833fb8c61a5a
 SHA512:
-  metadata.gz: 8e5b4b579054a15876c18fac6f9aa2e943de5239d6d6afb8b20f4125019620f140d6a7345b54920a50f5aee244f5042c0d6bfe96594cceb16e772707bfe0d6e6
-  data.tar.gz: 5bbff614bca428be4940f99ce1de2f5a67fc8616171fb72f3cc3aba19abe54024305a6c14927b890e20090b0a773b60dd0637f87b1cd716484b67a9b7913d1f2
+  metadata.gz: 63d7c304cba528800c94270363be9dfa8cbd238fdd7200b82ab4344fce56390b5e7e3413e28626cd8c1092802062fa346e51831f24c779b8338b87b8e8743b2a
+  data.tar.gz: d68799840defcf2cbfab3d284b5aeaf090bb1ff9ad8c9e41f6bc937e24fee6accb9bfe08fc538360017fef1d09ff5bcd0395d36177bb439b073803b491c6d1a7

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Alex Kleissner
+Copyright (c) 2014 Keen IO
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,11 +1,23 @@
 # devise_keen gem
 
-Track user signin and signouts automatically to your Keen IO project.
+Track user signin and signouts to your Keen IO project automatically.
 
 ## Requirements
 
+As this is a devise extension, you'll need the devise gem, along with some Keen IO related gems.
+
 The devise_keen gem requires the [keen gem](https://rubygems.org/gems/keen) and a [Keen IO account](https://keen.io) (free to sign up).
 
+## Installation
+
+The only thing you need to do is install the keen_devise gem,
+
+`gem install keen_devise`
+
+or add the `keen_devise` gem to your Gemfile:
+
+`gem 'keen_devise'`
+
 ## Configuration
 
 There are three configuration paramters:
@@ -14,8 +26,8 @@ There are three configuration paramters:
     *Required*. The project id to write to.
 *  `keen_write_key`  
     *Required*. The Keen IO write key.
-*  `keen_collection`  
-    The optional collection name to store events in. If not set, will default to `devise-keen`
+*  `keen_collection_prefix`  
+    This gems stores the signin and signout events in two different collections. If you do not specify a prefix, it will default to `devise-keen`. The collection names will look like {keen_collection_prefix}-signin and {keen_collection_prefix}-signout.
 
 Define these variables in `config/initializers/devise.rb`.
 
@@ -25,21 +37,16 @@ Example config:
 # Keen IO Config
 config.keen_project_id = "ASDF12345"  
 config.keen_write_key = "REALLYLONGWRITEKEYHERE1234567890"  
-config.keen_collection = "user-events"
+config.keen_collection_prefix = "user-events"
 ```
 
 ## Contributing to devise_keen
  
-* 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.
+* Make sure you're on the latest version of the gem to make sure the feature hasn't already been implemented.
+* If it hasn't, check to see if someone has created an issue for it.
+* If you want to be an awesome contributor, fork it, branch it, push it!
 
 ## Copyright
 
-Copyright (c) 2014 Alex Kleissner. See LICENSE.txt for
-further details.
+Copyright (c) 2014 Keen IO. See LICENSE.txt for further details.
 

data/Rakefile

@@ -15,10 +15,10 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "devise_keen"
-  gem.homepage = "http://github.com/alex@keen.io/devise_keen"
+  gem.homepage = "https://github.com/keenlabs/devise_keen"
   gem.license = "MIT"
-  gem.summary = "Add basic automatic logging to the Keen IO service when a user logs in."
-  gem.description = "Publish an event to your Keen IO project every time a user logs in. Allows for customizing the collection name."
+  gem.summary = "Log signin and signout events to Keen IO."
+  gem.description = "Publish an event to your Keen IO project every time a user signs in or out. Allows for customizing the collection name."
   gem.email = "alex@keen.io"
   gem.authors = ["Alex Kleissner"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/devise_keen.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: devise_keen 0.1.1 ruby lib
+# stub: devise_keen 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "devise_keen"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Alex Kleissner"]
   s.date = "2014-09-16"
-  s.description = "Publish an event to your Keen IO project every time a user logs in. Allows for customizing the collection name."
+  s.description = "Publish an event to your Keen IO project every time a user signs in or out. Allows for customizing the collection name."
   s.email = "alex@keen.io"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -34,14 +34,12 @@ Gem::Specification.new do |s|
     "lib/devise_keen/hooks/signout.rb",
     "lib/devise_keen/model.rb",
     "lib/devise_keen/rails.rb",
-    "lib/devise_keen/version.rb",
-    "test/helper.rb",
-    "test/test_devise_keen.rb"
+    "lib/devise_keen/version.rb"
   ]
-  s.homepage = "http://github.com/alex@keen.io/devise_keen"
+  s.homepage = "https://github.com/keenlabs/devise_keen"
   s.licenses = ["MIT"]
   s.rubygems_version = "2.2.2"
-  s.summary = "Add basic automatic logging to the Keen IO service when a user logs in."
+  s.summary = "Log signin and signout events to Keen IO."
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/lib/devise_keen.rb

@@ -24,9 +24,9 @@ module Devise
   # Public: The name of the collection to use when recording events.
   # Set keen_collection in the Devise configuration file (config/initializers/devise.rb)
   #
-  #   Devise.keen_collection = "devise-keen"
-  mattr_accessor :keen_collection
-  @@keen_collection = "devise-keen"
+  #   Devise.keen_collection_prefix = "devise-keen"
+  mattr_accessor :keen_collection_prefix
+  @@keen_collection_prefix = "devise-keen"
 end
 
 module KeenTrackable

data/lib/devise_keen/model.rb

@@ -5,7 +5,7 @@ module Devise
   module Models
     module KeenTrackable
       def keen_record_signin
-        self.publish_action("signin", {sign_in_time: self.current_sign_in_at})
+        self.publish_action("signin", {sign_in_time: Time.now.iso8601})
       end
 
       def keen_record_signout
@@ -13,9 +13,10 @@ module Devise
       end
 
       protected
-      def publish_action(action, params)
+      def publish_action(collection, params)
         raise new Exception("Must define keen_project_id.") if self.class.keen_project_id.nil?
         raise new Exception("Must define keen_write_key.") if self.class.keen_write_key.nil?
+        collection_name = "#{self.class.keen_collection_prefix}-#{collection}"
 
         keen = Keen::Client.new(project_id: self.class.keen_project_id,
                                 write_key: self.class.keen_write_key)
@@ -24,18 +25,17 @@ module Devise
           user: {
             id: self.id,
             email: self.email
-          },
-          action: "#{action}"
+          }
         }
 
         event_params.merge!(params)
 
-        keen.publish(self.class.keen_collection, event_params)
+        keen.publish(collection_name, event_params)
       end
     end
 
     Devise::Models.config(self, :keen_project_id)
     Devise::Models.config(self, :keen_write_key)
-    Devise::Models.config(self, :keen_collection)
+    Devise::Models.config(self, :keen_collection_prefix)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: devise_keen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Kleissner
@@ -136,8 +136,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Publish an event to your Keen IO project every time a user logs in. Allows
-  for customizing the collection name.
+description: Publish an event to your Keen IO project every time a user signs in or
+  out. Allows for customizing the collection name.
 email: alex@keen.io
 executables: []
 extensions: []
@@ -161,9 +161,7 @@ files:
 - lib/devise_keen/model.rb
 - lib/devise_keen/rails.rb
 - lib/devise_keen/version.rb
-- test/helper.rb
-- test/test_devise_keen.rb
-homepage: http://github.com/alex@keen.io/devise_keen
+homepage: https://github.com/keenlabs/devise_keen
 licenses:
 - MIT
 metadata: {}
@@ -186,5 +184,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Add basic automatic logging to the Keen IO service when a user logs in.
+summary: Log signin and signout events to Keen IO.
 test_files: []

data/test/helper.rb

@@ -1,34 +0,0 @@
-require 'simplecov'
-
-module SimpleCov::Configuration
-  def clean_filters
-    @filters = []
-  end
-end
-
-SimpleCov.configure do
-  clean_filters
-  load_adapter 'test_frameworks'
-end
-
-ENV["COVERAGE"] && SimpleCov.start do
-  add_filter "/.rvm/"
-end
-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 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'devise_keen'
-
-class Test::Unit::TestCase
-end

data/test/test_devise_keen.rb

@@ -1,4 +0,0 @@
-require 'helper'
-
-class TestDeviseKeen < Test::Unit::TestCase
-end