devise_signin_loggable 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+signin

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in devise_signin_loggable.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Aaron Klaassen
+
+MIT License
+
+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,51 @@
+# devise\_signin\_loggable
+
+Every time a user signs in, log the time and IP.
+
+## Installation
+
+Add this to your Gemfile:
+
+    gem 'devise_signin_loggable'
+
+And run:
+
+    $ bundle
+
+Or install it with:
+
+    $ gem install devise_signin_loggable
+
+
+## Usage
+
+After installation, run in the install generator and migrations:
+
+    rails generate devise_signin_loggable:install
+    rake db:migrate
+
+The user models for which you want to log signins, add `:signin_loggable` to
+the list of included devise modules:
+
+    devise :signin_loggable
+
+## Configuration
+
+Since a table of every signin by every user can obviously grow quickly, there
+are two options to clear out old data: either by limiting the number of signins
+stored per user, or by only keeping signins less than a given age.
+
+In `devise.rb`, the generator adds the following lines:
+
+    # config.max_logged_signins_per_user = 50
+    # config.remove_logged_signins_older_than = 3.months
+
+Uncomment and edit the values to suit. You can enable both options, but a given
+log need only meet *one* of the conditions to be deleted.
+
+## Author
+
+Aaron Klaassen  
+aaron@outerspacehero.com  
+http://www.outerspacehero.com/  
+[@aaronklaassen](https://www.twitter.com/aaronklaassen/)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/devise_signin_loggable.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "devise_signin_loggable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "devise_signin_loggable"
+  s.version     = DeviseSigninLoggable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aaron Klaassen"]
+  s.email       = ["aaron@outerspacehero.com"]
+  s.homepage    = "https://github.com/aaronklaassen/devise_signin_loggable"
+  s.summary     = %q{Log your users' sign-ins.}
+  s.description = %q{Every time a user signs in, log the time and IP.}
+  s.license     = "MIT"
+
+  s.rubyforge_project = "devise_signin_loggable"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'devise', '>= 3.0.0'
+  s.add_dependency 'activerecord',  '>= 3.2.0'
+
+  s.add_development_dependency 'rspec',   '~> 2.14.1'
+  s.add_development_dependency 'shoulda', '~> 3.5.0'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'pry'
+end

data/lib/devise_signin_loggable.rb

@@ -0,0 +1,27 @@
+require 'devise'
+require 'devise_signin_loggable/logged_signin'
+
+module Devise
+
+  # By default, log everything.
+  mattr_accessor :max_logged_signins_per_user
+  @@max_signin_logs_per_user = nil
+
+  mattr_accessor :remove_logged_signins_older_than
+  @@remove_logged_signins_older_than = nil
+
+end
+
+Warden::Manager.after_authentication do |user,auth,opts|
+
+  # This can't be the right way to do this.
+  if user.class.ancestors.any? { |a| a.to_s.include?("SigninLoggable") }
+  
+    log = Devise::Models::LoggedSignin.new
+    log.resource = user
+    log.ip_address = auth.request.remote_ip
+    log.save
+  end
+end
+
+Devise.add_module(:signin_loggable, :model  => 'devise_signin_loggable/model')

data/lib/devise_signin_loggable/logged_signin.rb

@@ -0,0 +1,25 @@
+module Devise
+  module Models
+    class LoggedSignin < ::ActiveRecord::Base
+      belongs_to :resource, polymorphic: true
+
+      validates :resource, :ip_address, presence: true
+
+      after_create :remove_old_signins
+
+      scope :by_resource, lambda { |res| where(resource_id: res.id, resource_type: res.class.to_s) }
+
+      private
+
+      def remove_old_signins
+        by_user = Devise::Models::LoggedSignin.by_resource(resource)
+
+        min_date = resource.class.remove_logged_signins_older_than
+        max_signins = resource.class.max_logged_signins_per_user
+
+        by_user.where("created_at <= ?", min_date).destroy_all if min_date
+        by_user.reverse_order.offset(max_signins).destroy_all if max_signins
+      end
+    end
+  end
+end

data/lib/devise_signin_loggable/model.rb

@@ -0,0 +1,10 @@
+module Devise
+  module Models
+    module SigninLoggable
+      def self.included(obj)
+        Devise::Models.config(obj.class, :max_logged_signins_per_user,
+                                         :remove_logged_signins_older_than)
+      end
+    end
+  end
+end

data/lib/devise_signin_loggable/version.rb

@@ -0,0 +1,3 @@
+module DeviseSigninLoggable
+  VERSION = "0.1.0"
+end

data/lib/generators/devise_signin_loggable/install_generator.rb

@@ -0,0 +1,28 @@
+module DeviseSigninLoggable
+  class InstallGenerator < Rails::Generators::Base
+    
+    source_root File.expand_path("../templates", __FILE__) 
+
+    def create_default_devise_settings
+      inject_into_file "config/initializers/devise.rb", default_devise_settings, :after => "Devise.setup do |config|\n"   
+    end
+    
+    def copy_migration_file
+      copy_file '20140319161305_create_logged_signins.rb', 'db/migrate/20140319161305_create_logged_signins.rb'
+    end
+    
+    private
+    
+    def default_devise_settings
+      settings = <<-eof
+  # ==> Signin logging Configuration 
+  # config.max_logged_signins_per_user = 50
+  # config.remove_logged_signins_older_than = 3.months
+  
+      eof
+     
+      settings
+    end
+    
+  end
+end

data/lib/generators/devise_signin_loggable/templates/20140319161305_create_logged_signins.rb

@@ -0,0 +1,11 @@
+class CreateLoggedSignins < ActiveRecord::Migration
+  def change
+    create_table :logged_signins do |t|
+      
+      t.references :resource, polymorphic: true
+      t.string     :ip_address
+
+      t.timestamps
+    end
+  end
+end

data/spec/lib/logged_signin_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe Devise::Models::LoggedSignin do
+
+  def create_logged_signin(user, weeks_old = 0)
+    log = Devise::Models::LoggedSignin.new
+    log.resource = user
+    log.ip_address = "127.0.0.1"
+    log.created_at = weeks_old.weeks.ago
+    log.save!
+    log
+  end
+
+  before :each do
+    @user = User.create!
+    9.times { |i| create_logged_signin(@user, i) }
+    5.times { |i| create_logged_signin(User.create!, i) }
+  end
+
+  after :each do
+    User.destroy_all
+    Devise::Models::LoggedSignin.destroy_all
+  end
+
+  describe "associations" do
+    it { should belong_to(:resource) }
+  end
+
+  describe "removing previous signins on creation" do
+
+    context "devise is configured to remove old signins" do
+      it "deletes logged signins that are too old" do
+        User.stub(:remove_logged_signins_older_than).and_return(4.weeks.ago)
+        expect {
+          create_logged_signin(@user)
+        }.to change(Devise::Models::LoggedSignin, :count).by(-4)
+
+        cutoff = User.remove_logged_signins_older_than
+        old = Devise::Models::LoggedSignin.where("resource_id = ? AND created_at <= ?", @user.id, cutoff)
+        old.size.should be_zero
+      end
+    end
+
+    context "devise is not configured to remove old signins" do
+      it "does not delete any logged signins" do
+        User.stub(:remove_logged_signins_older_than).and_return(nil)
+        expect {
+          create_logged_signin(@user)
+        }.to change(Devise::Models::LoggedSignin, :count).by(1)
+      end
+    end
+
+    context "devise is configured to limit logged signins per user" do
+      it "deletes logged signins when there are too many" do
+        User.stub(:max_logged_signins_per_user).and_return(7)
+        create_logged_signin(@user)
+        Devise::Models::LoggedSignin.by_resource(@user).count.should == 7
+        Devise::Models::LoggedSignin.count.should == 12
+      end
+
+      it "deletes the oldest signins and keeps the newest ones" do
+        User.stub(:max_logged_signins_per_user).and_return(7)
+        all_logins = Devise::Models::LoggedSignin.by_resource(@user).to_a
+        new_log = create_logged_signin(@user)
+        Devise::Models::LoggedSignin.by_resource(@user).should == all_logins.last(6) + [new_log]
+      end
+    end
+
+    context "devise is not configured to limit logged signins" do
+      it "does not delete any logged signins" do
+        User.stub(:max_logged_signins_per_user).and_return(nil)
+        expect {
+          create_logged_signin(@user)
+        }.to change(Devise::Models::LoggedSignin, :count).by(1)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'active_record'
+require 'shoulda'
+require 'pry'
+require 'devise_signin_loggable'
+
+RSpec.configure do |config|
+  config.order = "random"
+
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+  ActiveRecord::Schema.define do
+    self.verbose = false
+
+    # See the generator migration.
+    create_table :logged_signins do |t|
+      
+      t.references :resource, polymorphic: true
+      t.string     :ip_address
+
+      t.timestamps
+    end
+
+    # A stub for the specs.
+    create_table :users do |t|
+    end
+    
+  end
+end
+
+class User < ActiveRecord::Base;
+  def self.remove_logged_signins_older_than; end
+  def self.max_logged_signins_per_user; end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: devise_signin_loggable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Klaassen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: devise
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Every time a user signs in, log the time and IP.
+email:
+- aaron@outerspacehero.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- devise_signin_loggable.gemspec
+- lib/devise_signin_loggable.rb
+- lib/devise_signin_loggable/logged_signin.rb
+- lib/devise_signin_loggable/model.rb
+- lib/devise_signin_loggable/version.rb
+- lib/generators/devise_signin_loggable/install_generator.rb
+- lib/generators/devise_signin_loggable/templates/20140319161305_create_logged_signins.rb
+- spec/lib/logged_signin_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aaronklaassen/devise_signin_loggable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: devise_signin_loggable
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Log your users' sign-ins.
+test_files:
+- spec/lib/logged_signin_spec.rb
+- spec/spec_helper.rb