activerecord_session_cleaner 1.0.0

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+activerecord_session_cleaner

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p194

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nine Internet Solutions AG (nine.ch)
+
+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,30 @@
+# activerecord_session_cleaner [![Gem Version](https://badge.fury.io/rb/activerecord_session_cleaner.png)](http://badge.fury.io/rb/activerecord_session_cleaner)
+
+Gem to remove old sessions from your ActiveRecord DB.
+
+## Features
+
+* Delete all sessions
+* Delete sessions not updated in the last `$x` days
+* Setup cleanup cron to delete old sessions
+
+## Tasks
+
+    # Delete old sessions from an Active Record session store
+    rake activerecord_session_cleaner:cleanup:old[days_to_keep]
+    # Delete all session from an Active Record session store
+    rake activerecord_session_cleaner:cleanup:all
+
+    # Setup/update cron for session cleanup
+    rake activerecord_session_cleaner:crontab:update[application_name,days_to_keep]
+    # Remove cleanup cron for session cleanup
+    rake activerecord_session_cleaner:crontab:clear[application_name]
+
+Default values:
+
+* `days_to_keep`: `10`
+* `application_name`: basename of the current working directory (`example` if you are in `/home/gooby/example`)
+
+## License
+
+activerecord_session_cleaner is released under the MIT License. See [LICENSE.txt](LICENSE.txt) for further details.

data/Rakefile

@@ -0,0 +1,4 @@
+#!/usr/bin/env rake
+require 'bundler'
+require 'rake'
+require 'bundler/gem_tasks'

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/activerecord_session_cleaner.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name        = 'activerecord_session_cleaner'
+  s.version     = File.read(File.expand_path('../VERSION', __FILE__)).strip
+  s.authors     = ['Nils Caspar']
+  s.email       = 'info@nine.ch'
+  s.homepage    = 'https://github.com/ninech/activerecord_session_cleaner'
+  s.license     = 'MIT'
+  s.summary     = 'Gem to remove old sessions from your ActiveRecord DB'
+  s.description = 'This gem allows you to automatically remove old sessions from your ActiveRecord.'
+
+  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_development_dependency 'rake', '~> 10.0'
+
+  s.add_runtime_dependency 'whenever', '~> 0.9'
+end

data/lib/activerecord_session_cleaner.rb

@@ -0,0 +1,4 @@
+require 'activerecord_session_cleaner/railtie' if defined?(Rails)
+
+module ActiverecordSessionCleaner
+end

data/lib/activerecord_session_cleaner/railtie.rb

@@ -0,0 +1,5 @@
+module ActiverecordSessionCleaner
+  class Railtie < Rails::Railtie
+    rake_tasks { require 'activerecord_session_cleaner/tasks' }
+  end
+end

data/lib/activerecord_session_cleaner/session.rb

@@ -0,0 +1,4 @@
+module ActiverecordSessionCleaner
+  class Session < ActiveRecord::Base
+  end
+end

data/lib/activerecord_session_cleaner/tasks.rb

@@ -0,0 +1 @@
+Dir[File.join(File.dirname(__FILE__),'tasks/*.rake')].each { |f| load f }

data/lib/activerecord_session_cleaner/tasks/cleanup.rake

@@ -0,0 +1,28 @@
+require 'activerecord_session_cleaner/session'
+
+namespace :activerecord_session_cleaner do
+  namespace :cleanup do
+    def puts_if_verbose(message)
+      puts message if Rake.verbose
+    end
+
+    desc 'Delete old sessions from an Active Record session store'
+    task :old, [:days_to_keep] => :environment do |t, args|
+      keep_after = if !(/^[0-9]+$/ =~ args.days_to_keep)
+                     10.days.ago
+                   else
+                     args.days_to_keep.to_i.days.ago
+                   end
+      puts_if_verbose "\e[1;33mDeleting sessions before #{keep_after}\e[0m"
+      deleted_sessions = ActiverecordSessionCleaner::Session.delete_all(['updated_at < ?', keep_after])
+      puts_if_verbose "\e[1;32m#{deleted_sessions} old sessions were deleted\e[0m"
+    end
+
+    desc 'Delete all session from an Active Record session store'
+    task all: :environment do
+      puts_if_verbose "\e[1;33mTruncating sessions table\e[0m"
+      ActiverecordSessionCleaner::Session.truncate
+      puts_if_verbose "\e[1;32mAll sessions were deleted\e[0m"
+    end
+  end
+end

data/lib/activerecord_session_cleaner/tasks/crontab.rake

@@ -0,0 +1,47 @@
+require 'erb'
+require 'ostruct'
+require 'tempfile'
+require 'whenever'
+
+require 'activerecord_session_cleaner/session'
+
+namespace :activerecord_session_cleaner do
+  namespace :crontab do
+    class ERBStruct < OpenStruct
+      def render(template)
+        ERB.new(template).result(binding)
+      end
+    end
+
+    def whenever_identifier(application_name = nil)
+      application_name ||= File.basename(Dir.pwd)
+      "#{application_name}-activerecord_session_cleaner"
+    end
+
+    DEFAULT_ENVIRONMENT = 'development'
+
+    desc 'Setup/update cron for session cleanup'
+    task :update, [:application_name, :days_to_keep] => :environment do |t, args|
+      template_data = ERBStruct.new(days_to_keep: args.days_to_keep)
+      template = File.read(File.expand_path('../../templates/schedule.rb.erb', __FILE__))
+      schedule_file = Tempfile.new('activerecord_session_cleaner-schedule')
+      schedule_file.write template_data.render(template)
+      schedule_file.close(false)
+      Whenever::CommandLine.execute({
+        update: true,
+        identifier: whenever_identifier(args.application_name),
+        file: schedule_file.path,
+        set: "environment=#{ENV['RAILS_ENV'] || DEFAULT_ENVIRONMENT}",
+      })
+      schedule_file.unlink
+    end
+
+    desc 'Remove cleanup cron for session cleanup'
+    task :clear, [:application_name] => :environment do |t, args|
+      Whenever::CommandLine.execute({
+        clear: true,
+        identifier: whenever_identifier(args.application_name),
+      })
+    end
+  end
+end

data/lib/activerecord_session_cleaner/templates/schedule.rb.erb

@@ -0,0 +1,3 @@
+every :hour do
+  rake "activerecord_session_cleaner:cleanup:old[<%= days_to_keep %>]"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_session_cleaner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nils Caspar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: whenever
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: This gem allows you to automatically remove old sessions from your ActiveRecord.
+email: info@nine.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- activerecord_session_cleaner.gemspec
+- config/schedule.rb
+- lib/activerecord_session_cleaner.rb
+- lib/activerecord_session_cleaner/railtie.rb
+- lib/activerecord_session_cleaner/session.rb
+- lib/activerecord_session_cleaner/tasks.rb
+- lib/activerecord_session_cleaner/tasks/cleanup.rake
+- lib/activerecord_session_cleaner/tasks/crontab.rake
+- lib/activerecord_session_cleaner/templates/schedule.rb.erb
+homepage: https://github.com/ninech/activerecord_session_cleaner
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Gem to remove old sessions from your ActiveRecord DB
+test_files: []