devise-stalkable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a3bba72a13bc3bd2d7d6cbb871ca4bfb684d5b8f
+  data.tar.gz: 955be64c8caa5d8413035c4a696a19888f8e3476
+SHA512:
+  metadata.gz: d06806b40ae774d9d51be70d25b82c9c4e29c11d95cc8c281eaf99046cf4889cba320cfb30fecaeeffa28015ddb4096faa1897933d47adae89c318067d76d759
+  data.tar.gz: c230d1398e6dc3ad42471548115777ff5d3260c2e749e13173ce1471b74268b1d492eeb4b269d3c97ce0e6b57bf46894cc7fd04b28b8e509353b2bfb88e8f962

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in devise-stalkable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Cameron
+
+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,54 @@
+# Devise::Stalkable
+
+Stalkable is a gem that tracks logins of each user. Based on [devise-login_tracker](https://github.com/blueberryapps/devise-login_tracker)
+
+## Installation
+
+Add this line to your application's Gemfile (not on rubygems yet!):
+
+    gem 'devise-stalkable', github: "unchris/stalkable"
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+Run the generator with the model name (User in this example):
+
+    $ rails g devise_stalkable User
+
+Add `:stalkable` to `devise` in your model and association
+to the login records. Example for User model:
+
+```ruby
+class User < ActiveRecord::Base
+  devise :database_authenticatable, ..... , :stalkable
+
+  has_many :logins, class_name: 'UserLogin'
+end
+```
+
+## What is being tracked
+
+For each login new record is created with following attributes:
+
+* `ip_address` - IP address
+* `user_agent` - User agent
+* `signed_in_at` - Signed in at
+* `last_seen_at` - Last seen at (on new requests)
+* `signed_in_at` -  Signed out at (upon sign out)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright © 2014 Chris Cameron. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+

data/devise-stalkable.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'devise/stalkable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "devise-stalkable"
+  spec.version       = Devise::Stalkable::VERSION
+  spec.authors       = ["Chris Cameron"]
+  spec.email         = ["unchris@outlook.com"]
+  spec.description   = %q{Tracks a user's login, logout, and requests}
+  spec.summary       = %q{Tracks a user's login, logout, and requests}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', "~> 1.3"
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_runtime_dependency 'devise', '>= 3.0.0'
+  spec.add_runtime_dependency 'rails', '>= 3.1.0'
+
+end

data/lib/devise/hooks/stalkable.rb

@@ -0,0 +1,26 @@
+require 'warden'
+
+Warden::Manager.after_authentication do |record, warden, opts|
+  if record.respond_to?(:mark_login!)
+    login_record = record.mark_login!(warden.request)
+    scope = opts[:scope]
+    warden.session["#{scope}.login_id"] = login_record.id
+  end
+end
+
+Warden::Manager.after_set_user do |record, warden, opts|
+  if record.respond_to?(:mark_last_seen!)
+    scope = opts[:scope]
+    login_record_id = warden.session["#{scope}.login_id"]
+    record.mark_last_seen!(login_record_id) if login_record_id
+  end
+end
+
+Warden::Manager.before_logout do |record, warden, opts|
+  if record.respond_to?(:mark_logout!)
+    scope = opts[:scope]
+    login_record_id = warden.session["#{scope}.login_id"]
+    record.mark_logout!(login_record_id) if login_record_id
+  end
+end
+

data/lib/devise/models/stalkable.rb

@@ -0,0 +1,55 @@
+require 'active_support/inflector'
+
+module Devise
+  module Models
+    module Stalkable
+
+      # Creates a new login record based on information in provided request
+      # object.
+      # Marks the last seen time as well.
+      #
+      # @param [ActionDispatch::Request] request HTTP request which was used
+      # to login
+      # @return [UserLogin]
+      def mark_login!(request)
+        login_class.create(attrs_for_login(request))
+      end
+
+      # Marks the time when the user was last seen in the system on a given
+      # login record ID.
+      #
+      # @param [Fixnum, String] login_record_id ID of login record.
+      def mark_last_seen!(login_record_id)
+        login_record = login_class.find(login_record_id)
+        login_record.update_column :last_seen_at, Time.now
+      end
+
+      # Marks the time when user has logged out on given login record ID.
+      # Marks the last seen time as well.
+      #
+      # @param [Fixnum, String] login_record_id ID of login record.
+      def mark_logout!(login_record_id)
+        login_record = login_class.find(login_record_id)
+        t = Time.now
+        login_record.update_column :last_seen_at, t
+        login_record.update_column :signed_out_at, t
+      end
+
+      protected
+
+      def attrs_for_login(request)
+        t = Time.now
+        { user_id: id, ip_address: request.remote_ip,
+          user_agent: request.user_agent,
+          signed_in_at: t,
+          last_seen_at: t }
+      end
+
+      def login_class
+        "#{self.class.name}Login".safe_constantize
+      end
+
+    end
+  end
+end
+

data/lib/devise/stalkable/rails.rb

@@ -0,0 +1,6 @@
+module Devise
+  class Stalkable
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/devise/stalkable/version.rb

@@ -0,0 +1,5 @@
+module Devise
+  module Stalkable
+    VERSION = "0.0.1"
+  end
+end

data/lib/devise/stalkable.rb

@@ -0,0 +1,7 @@
+require 'devise'
+require 'devise/stalkable/version'
+require 'devise/hooks/stalkable'
+require 'devise/models/stalkable'
+
+Devise.add_module :stalkable, :model => 'devise/models/stalkable'
+

data/lib/generators/devise_stalkable/devise_stalkable_generator.rb

@@ -0,0 +1,60 @@
+require 'rails/generators/migration'
+
+class DeviseStalkableGenerator < Rails::Generators::NamedBase
+
+  include Rails::Generators::Migration
+
+  desc "Generates a model with the given NAME (if one does not exist) with" <<
+      "devise configuration plus a migration file and devise routes."
+
+  def self.source_root
+    @_devise_source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  def self.orm_has_migration?
+    Rails::Generators.options[:rails][:orm] == :active_record
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    else
+      '%.3d' % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  class_option :orm
+  class_option :migration, :type => :boolean, :default => orm_has_migration?
+
+  def invoke_orm_model
+    if model_exists?
+      say "* Model #{name}Login already exists."
+    elsif options[:orm].present?
+      invoke "model", ["#{name}Login", "#{name}:belongs_to"], :migration => false,
+        :orm => options[:orm]
+
+      unless model_exists?
+        abort "Tried to invoke the model generator for '#{options[:orm]}' but could not find it.\n" <<
+        "Please create your model by hand before calling `rails g devise_stalkable #{name}`."
+      end
+    else
+      abort "Cannot create a devise model because config.generators.orm is blank.\n" <<
+      "Please create your model by hand or configure your generators orm before calling `rails g devise_stalkable #{name}`."
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', "db/migrate/devise_create_#{name.downcase}_logins.rb"
+  end
+
+  protected
+
+  def model_exists?
+    File.exists?(File.join(destination_root, model_path))
+  end
+
+  def model_path
+    @model_path ||= File.join('app', 'models', "#{file_path}_login.rb")
+  end
+
+end

data/lib/generators/devise_stalkable/templates/migration.rb

@@ -0,0 +1,20 @@
+class DeviseCreate<%= table_name.camelize.singularize %>Logins < ActiveRecord::Migration
+
+  def up
+    create_table :<%= table_name.singularize %>_logins do |t|
+      t.integer  :<%= table_name.classify.foreign_key  %>
+      t.string :ip_address
+      t.string :user_agent
+      t.datetime :signed_in_at
+      t.datetime :last_seen_at
+      t.datetime :signed_out_at
+    end
+
+    add_index :<%= table_name.singularize %>_logins, :<%= table_name.classify.foreign_key  %>
+  end
+
+  def down
+    drop_table :<%= table_name.singularize %>_logins
+  end
+
+end

data/spec/devise-stalkable/models_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+class TestModel
+  include Devise::Models::Stalkable
+
+  def id
+    1
+  end
+end
+
+class TestModelLogin
+end
+
+describe Devise::Models::Stalkable do
+
+  let(:model) { TestModel.new }
+
+  describe '#mark_login!' do
+
+    it 'creates a new login record' do
+      expect(TestModelLogin).to receive(:create)
+      request = double.as_null_object
+      model.mark_login!(request)
+    end
+
+    it 'uses model id' do
+      expect(TestModelLogin).to receive(:create).with(hash_including(user_id: 1))
+      request = double.as_null_object
+      model.mark_login!(request)
+    end
+
+  end
+
+  describe '#mark_logout!' do
+
+    let(:record) { double update_column: nil }
+
+    before do
+      allow(TestModelLogin).to receive(:find).and_return record
+    end
+
+    it 'finds the record by given ID' do
+      expect(TestModelLogin).to receive(:find).with(1)
+      model.mark_logout!(1)
+    end
+
+    it 'finds the record by given ID' do
+      now = double
+      allow(Time).to receive(:now).and_return now
+      expect(record).to receive(:update_column).with(:signed_out_at, now)
+      expect(record).to receive(:update_column).with(:last_seen_at, now)
+      model.mark_logout!(1)
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'devise/stalkable'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: devise-stalkable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Cameron
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: devise
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Tracks a user's login, logout, and requests
+email:
+- unchris@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- devise-stalkable.gemspec
+- lib/devise/hooks/stalkable.rb
+- lib/devise/models/stalkable.rb
+- lib/devise/stalkable.rb
+- lib/devise/stalkable/rails.rb
+- lib/devise/stalkable/version.rb
+- lib/generators/devise_stalkable/devise_stalkable_generator.rb
+- lib/generators/devise_stalkable/templates/migration.rb
+- spec/devise-stalkable/models_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Tracks a user's login, logout, and requests
+test_files:
+- spec/devise-stalkable/models_spec.rb
+- spec/spec_helper.rb