devise_keen 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9eda9f2d7a8e03e47bb7d23a1d6cabbf4293c803
+  data.tar.gz: bc13378e957a35b7f96a6d91959aceb2c2c4b4f6
+SHA512:
+  metadata.gz: 8e5b4b579054a15876c18fac6f9aa2e943de5239d6d6afb8b20f4125019620f140d6a7345b54920a50f5aee244f5042c0d6bfe96594cceb16e772707bfe0d6e6
+  data.tar.gz: 5bbff614bca428be4940f99ce1de2f5a67fc8616171fb72f3cc3aba19abe54024305a6c14927b890e20090b0a773b60dd0637f87b1cd716484b67a9b7913d1f2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'rails'
+gem 'warden'
+gem 'devise'
+gem 'keen'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Alex Kleissner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# devise_keen gem
+
+Track user signin and signouts automatically to your Keen IO project.
+
+## Requirements
+
+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).
+
+## Configuration
+
+There are three configuration paramters:
+
+*  `keen_project_id`  
+    *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`
+
+Define these variables in `config/initializers/devise.rb`.
+
+Example config:
+
+```ruby
+# Keen IO Config
+config.keen_project_id = "ASDF12345"  
+config.keen_write_key = "REALLYLONGWRITEKEYHERE1234567890"  
+config.keen_collection = "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.
+
+## Copyright
+
+Copyright (c) 2014 Alex Kleissner. See LICENSE.txt for
+further details.
+

data/README.rdoc

@@ -0,0 +1,19 @@
+= devise_keen
+
+Description goes here.
+
+== 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.
+
+== Copyright
+
+Copyright (c) 2014 Alex Kleissner. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+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 'rake'
+
+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.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.email = "alex@keen.io"
+  gem.authors = ["Alex Kleissner"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "devise_keen #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/devise_keen.gemspec

@@ -0,0 +1,82 @@
+# Generated by jeweler
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "devise_keen"
+  s.version = "0.1.1"
+
+  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.email = "alex@keen.io"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "devise_keen.gemspec",
+    "lib/devise_keen.rb",
+    "lib/devise_keen/hooks/keen_metrics.rb",
+    "lib/devise_keen/hooks/signin.rb",
+    "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"
+  ]
+  s.homepage = "http://github.com/alex@keen.io/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."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rails>, [">= 0"])
+      s.add_runtime_dependency(%q<warden>, [">= 0"])
+      s.add_runtime_dependency(%q<devise>, [">= 0"])
+      s.add_runtime_dependency(%q<keen>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<warden>, [">= 0"])
+      s.add_dependency(%q<devise>, [">= 0"])
+      s.add_dependency(%q<keen>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<warden>, [">= 0"])
+    s.add_dependency(%q<devise>, [">= 0"])
+    s.add_dependency(%q<keen>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/lib/devise_keen.rb

@@ -0,0 +1,35 @@
+unless defined?(Devise)
+  require 'devise'
+end
+require 'keen'
+require 'devise_keen'
+
+Devise.add_module :keen_trackable, :model => 'devise_keen/model'
+
+module Devise
+  # Public: The Keen project id to use when recording events.
+  # Set keen_project_id in the Devise configuration file (config/initializers/devise.rb)
+  #
+  #   Devise.keen_project_id = "YOURPROJECTID"
+  mattr_accessor :keen_project_id
+  @@keen_project_id = nil
+
+  # Public: The Keen Write Key for your project. Used to record events.
+  # Set keen_write_key in the Devise configuration file (config/initializers/devise.rb)
+  #
+  #   Devise.keen_write_key = "YOUR_WRITE_KEY"
+  mattr_accessor :keen_write_key
+  @@keen_write_key = nil
+
+  # 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"
+end
+
+module KeenTrackable
+end
+
+require 'devise_keen/rails'

data/lib/devise_keen/hooks/keen_metrics.rb

@@ -0,0 +1,5 @@
+Warden::Manager.after_set_user do |record, warden, opts|
+  if record.respond_to?(:record_login)
+    record.record_login
+  end
+end

data/lib/devise_keen/hooks/signin.rb

@@ -0,0 +1,5 @@
+Warden::Manager.after_authentication do |record, warden, opts|
+  if record.respond_to?(:keen_record_signin)
+    record.keen_record_signin
+  end
+end

data/lib/devise_keen/hooks/signout.rb

@@ -0,0 +1,5 @@
+Warden::Manager.before_logout do |record, warden, opts|
+  if record.respond_to?(:keen_record_signout)
+    record.keen_record_signout
+  end
+end

data/lib/devise_keen/model.rb

@@ -0,0 +1,41 @@
+require 'devise_keen/hooks/signin'
+require 'devise_keen/hooks/signout'
+
+module Devise
+  module Models
+    module KeenTrackable
+      def keen_record_signin
+        self.publish_action("signin", {sign_in_time: self.current_sign_in_at})
+      end
+
+      def keen_record_signout
+        self.publish_action("signout", {sign_out_time: Time.now.iso8601})
+      end
+
+      protected
+      def publish_action(action, 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?
+
+        keen = Keen::Client.new(project_id: self.class.keen_project_id,
+                                write_key: self.class.keen_write_key)
+
+        event_params = {
+          user: {
+            id: self.id,
+            email: self.email
+          },
+          action: "#{action}"
+        }
+
+        event_params.merge!(params)
+
+        keen.publish(self.class.keen_collection, event_params)
+      end
+    end
+
+    Devise::Models.config(self, :keen_project_id)
+    Devise::Models.config(self, :keen_write_key)
+    Devise::Models.config(self, :keen_collection)
+  end
+end

data/lib/devise_keen/rails.rb

@@ -0,0 +1,6 @@
+require 'devise_keen'
+
+module DeviseKeen
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/devise_keen/version.rb

@@ -0,0 +1,3 @@
+module DeviseKeen
+  VERSION = "0.0.1"
+end

data/test/helper.rb

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

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

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: devise_keen
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alex Kleissner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: keen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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.
+email: alex@keen.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- devise_keen.gemspec
+- lib/devise_keen.rb
+- lib/devise_keen/hooks/keen_metrics.rb
+- lib/devise_keen/hooks/signin.rb
+- 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
+homepage: http://github.com/alex@keen.io/devise_keen
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []